Skip to content

Commit f31909a

Browse files
tomsun28Aias00
andauthored
[doc] update security doc and some (apache#2856)
Signed-off-by: tomsun28 <[email protected]> Co-authored-by: aias00 <[email protected]>
1 parent 2df7e1d commit f31909a

File tree

9 files changed

+70
-84
lines changed

9 files changed

+70
-84
lines changed

.github/ISSUE_TEMPLATE/feature-request.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -53,4 +53,4 @@ body:
5353
validations:
5454
required: false
5555
- type: markdown
56-
value: "Please read the [Contribution Guideline](https://hertzbeat.apache.org/docs/others/contributing) before submitting the PR"
56+
value: "Please read the [Contribution Guideline](https://hertzbeat.apache.org/docs/community/contribution) before submitting the PR"

.github/ISSUE_TEMPLATE/task.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -39,4 +39,4 @@ body:
3939
- type: markdown
4040
attributes:
4141
value: |
42-
Please read the [Contribution Guideline](https://hertzbeat.com/docs/others/contributing/) before submitting the PR
42+
Please read the [Contribution Guideline](https://hertzbeat.apache.org/docs/community/contribution) before submitting the PR

.github/ISSUE_TEMPLATE/volunteer.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -30,5 +30,5 @@ body:
3030
- type: markdown
3131
attributes:
3232
value: |
33-
Please read the [Contribution Guideline](https://hertzbeat.apache.org/docs/others/contributing/) before submitting the PR
33+
Please read the [Contribution Guideline](https://hertzbeat.apache.org/docs/community/contribution) before submitting the PR
3434

.github/workflows/backend-build-test-reuse.yml

-71
This file was deleted.

.github/workflows/backend-build-test.yml

+41-3
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,44 @@ on:
4040

4141
jobs:
4242
backend-build:
43-
uses: ./.github/workflows/backend-build-test-reuse.yml
44-
secrets:
45-
codecov_token: ${{ secrets.CODECOV_TOKEN }}
43+
runs-on: ubuntu-latest
44+
steps:
45+
- uses: actions/checkout@v4
46+
- uses: ./script/ci/github-actions/setup-deps
47+
48+
- name: Build with Maven
49+
run: mvn clean -B package -Prelease -Dmaven.test.skip=false --file pom.xml
50+
51+
- name: Upload coverage reports to Codecov
52+
uses: codecov/[email protected]
53+
with:
54+
token: ${{ secrets.CODECOV_TOKEN }}
55+
verbose: true
56+
57+
- name: Build Image
58+
uses: docker/build-push-action@v3
59+
with:
60+
context: ./dist
61+
file: ./script/docker/server/Dockerfile
62+
push: false
63+
tags: apache/hertzbeat:test
64+
65+
- name: Run E2E
66+
run: |
67+
sudo curl -L https://github.com/docker/compose/releases/download/v2.23.0/docker-compose-linux-x86_64 -o /usr/local/bin/docker-compose
68+
sudo chmod u+x /usr/local/bin/docker-compose
69+
70+
cd e2e
71+
sudo docker-compose version
72+
sudo docker-compose up --exit-code-from testing --remove-orphans
73+
74+
# upload application logs
75+
- name: Upload logs & API test reports
76+
uses: actions/upload-artifact@v3
77+
if: always()
78+
with:
79+
name: hz-logs-${{ github.run_id }}
80+
path: |
81+
e2e/logs/
82+
e2e/report/
83+

SECURITY.md

+9-6
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,22 @@
11
# Security Policy
22

3-
**[Version Releases](https://github.com/apache/hertzbeat/releases)**
3+
Apache HertzBeat follows the [ASF vulnerability handling process](https://apache.org/security/#vulnerability-handling)
44

55
## Supported Versions
66

7-
Use this section to tell people about which versions of your project are
8-
currently being supported with security updates.
9-
107
| Version | Supported |
118
|-------------------|--------------------|
129
| Latest Version | :white_check_mark: |
1310
| Any Other Version | :x: |
1411

1512
## Reporting a Vulnerability
1613

17-
Use this section to tell people how to report a vulnerability.
14+
Please do not file GitHub issues for security vulnerabilities as they are public!
15+
16+
To report a new vulnerability you have discovered please follow the [ASF vulnerability reporting process](https://apache.org/security/#reporting-a-vulnerability).
17+
18+
## Extra Information
1819

19-
Please report vulnerability disclosures to `[email protected]`.
20+
- [Apache HertzBeat Security Model](https://hertzbeat.apache.org/docs/help/security_model)
21+
- [ASF Security](https://www.apache.org/security/)
22+
- [Apache HertzBeat Document](https://hertzbeat.apache.org/docs/)

home/docs/help/security_model.md

+8
Original file line numberDiff line numberDiff line change
@@ -33,3 +33,11 @@ Apache HertzBeat supports users to customize collectors to personalize the colle
3333
## Security Constraints in Other Customizations
3434

3535
Apache HertzBeat provides a variety of system extension methods and custom capabilities. Users need to pay attention to the security of customizations during use. Of course, all extension capabilities need to be within the scope of authenticated users.
36+
37+
----
38+
39+
## Reporting a Vulnerability
40+
41+
Please do not file GitHub issues for security vulnerabilities as they are public!
42+
43+
To report a new vulnerability you have discovered please follow the [ASF vulnerability reporting process](https://apache.org/security/#reporting-a-vulnerability).

home/docusaurus.config.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -153,7 +153,7 @@ module.exports = {
153153
},
154154
{
155155
label: 'Security',
156-
href: 'https://www.apache.org/security/',
156+
to: '/docs/help/security_model',
157157
},
158158
{
159159
label: 'Sponsorship',

home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/security_model.md

+8
Original file line numberDiff line numberDiff line change
@@ -33,3 +33,11 @@ Apache HertzBeat 支持用户自定义采集器来个性化采集监控指标等
3333
## 其它自定义下的安全约束
3434

3535
Apache HertzBeat 提供多种系统扩展方式和自定义能力,用户在使用过程中需注意自定义的安全性。当然所有扩展能力都是需在认证用户范围。
36+
37+
----
38+
39+
## Reporting a Vulnerability
40+
41+
Please do not file GitHub issues for security vulnerabilities as they are public!
42+
43+
To report a new vulnerability you have discovered please follow the [ASF vulnerability reporting process](https://apache.org/security/#reporting-a-vulnerability).

0 commit comments

Comments
 (0)