Skip to content

Commit a4f3077

Browse files
authored
docs: add templates for advanced disclosure and security release emails in runbook (#4529)
1 parent 2d05aec commit a4f3077

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

doc/security_issue_runbook.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,16 @@ For information on what types of issues are considered security vulnerabilities
2525
- Request CVE: Use the Big Green Button on the advisory to request a CVE number from GitHub staff.
2626
- Advanced Disclosure Email: Decide on a disclosure date, typically within a week, and send an email to [email protected] about the upcoming security release. Other ways are also available to communicate the disclosure date.
2727

28+
``` markdown
29+
> A template for the advanced disclosure email
30+
31+
The Wamr project would like to announce a forthcoming security release.
32+
33+
The release will be made available on approximately YYYY-MM-DD. Additionally, an advisory will be made available on the same date at https://github.com/advisories.
34+
35+
The highest severity issue fixed in this release is classified as XXX based on the CVSS classification scheme.
36+
```
37+
2838
## Step 5: Preparing and Testing Patch Releases
2939

3040
- Prepare PRs for Patch Releases: Create pull requests in the private fork for each version being patched. Ensure each PR is ready to apply cleanly and includes release notes for each release branch.
@@ -38,6 +48,16 @@ For information on what types of issues are considered security vulnerabilities
3848
- Publish GitHub Advisories: Delete the private forks and use the Big Green Button to publish the advisory.
3949
- Send Security Release Email: Send a follow-up email to [email protected] describing the security release. Other communication channels can also be used to inform users about the security release.
4050

51+
```markdown
52+
> A template for the security release email
53+
54+
[Updated YYYY-MM-DD] Security release available.
55+
56+
WAMR release version X.Y.Z is now available. The binary release can be found on GitHub at https://github.com/bytecodealliance/wasm-micro-runtime/releases/tag/WAMR-Y.Y.Z. This release addresses the following security issues rated XXX: https://the link of the advisory
57+
58+
We’ll be conducting a full review of our security practices to ensure ample notification is provided for future security releases.
59+
```
60+
4161
By following these steps, you can effectively manage and resolve security issues for your open source project, ensuring timely communication and collaboration while maintaining the integrity and security of your software.
4262

4363
## References

0 commit comments

Comments
 (0)