Skip to content

Commit d335c07

Browse files
authored
Adjust vulnerability runbook to not open PR version bumps (#11919)
Historically this was needed to give some time to figure out CI issues, if any. Nowadays though we test all release branches weekly to ensure their CI is running so any failures should be at most a week old. Given that there's no need to open version bumps ahead of time. This also avoids leaking information in advance disclosure about affected versions which narrows the range of the where the bug could be.
1 parent e4190de commit d335c07

File tree

1 file changed

+25
-24
lines changed

1 file changed

+25
-24
lines changed

docs/security-vulnerability-runbook.md

Lines changed: 25 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -64,33 +64,34 @@ is created these steps are followed:
6464
it, and that's ok, but try to get the ones that may have common failures.
6565
This is required because CI doesn't run on private forks.
6666

67-
10. **Open version bump PRs on the public repository**. Use the [online trigger]
68-
for this workflow to open PRs for all versions that are going to be patched.
69-
DO NOT include patch notes or release notes for this fix. Use this time to
70-
fix CI by landing PRs to the release branches separate from the version bump
71-
PR. DO NOT merge the version bump PR.
67+
10. **Release day: Open version bump PRs on the public repository**. Use the
68+
[online trigger] for this workflow to open PRs for all versions that are
69+
going to be patched. Patch notes should be included with the private PRs, so
70+
no need to worry about that. Plan on merging these PRs after the PRs below
71+
are merged. Note that CI should be green as we test that it's green weekly
72+
for all supported branches, but if it's not you'll need to fix that.
7273

7374
[online trigger]: https://github.com/bytecodealliance/wasmtime/actions/workflows/release-process.yml
7475

75-
11. **Manually make PRs on release day**. DO NOT merge via the security
76-
advisory. This has generally not worked well historically because there's
77-
too many CI failures and branch protections. On the day of the release make
78-
public PRs from all of the previously-created PRs on the private fork.
79-
You'll need to push the changes to your own personal repository for this,
80-
but that's ok since it's time to make things public anyway. Merge all PRs
81-
(including to `main`) once CI passes.
82-
83-
12. **Merge version bump PRs**. Once the fixes have all been merged and CI is
84-
green merge all the version bump PRs. That will trigger the automatic
85-
release process which will automatically publish to crates.io and publish
86-
the release.
87-
88-
13. **Publish the GitHub Advisories**. Delete the private forks and hit that Big
89-
Green Button to publish the advisory.
90-
91-
14. **Send mail about the security release**. Send another around of mail to
92-
[email protected] describing the security release. This mail
93-
looks [like
76+
11. **Release day: Manually make PRs to affected branches**. DO NOT merge via
77+
the security advisory. This has generally not worked well historically
78+
because there's too many CI failures and branch protections. On the day of
79+
the release make public PRs from all of the previously-created PRs on the
80+
private fork. You'll need to push the changes to your own personal
81+
repository for this, but that's ok since it's time to make things public
82+
anyway. Merge all PRs (including to `main`) once CI passes.
83+
84+
12. **Release day: Merge version bump PRs**. Once the fixes have all been merged
85+
and CI is green merge all the version bump PRs. That will trigger the
86+
automatic release process which will automatically publish to crates.io and
87+
publish the release.
88+
89+
13. **Release day: Publish the GitHub Advisories**. Delete the private forks and
90+
hit that Big Green Button to publish the advisory.
91+
92+
14. **Release day: Send mail about the security release**. Send another around
93+
of mail to [email protected] describing the security
94+
release. This mail looks [like
9495
this](https://groups.google.com/a/bytecodealliance.org/g/sec-announce/c/7SjEU_qSE4U/m/zjW9fWlcAAAJ).
9596

9697
14. **Add the advisory to the [RustSec

0 commit comments

Comments
 (0)