Merge pull request #1708 from hannobraun/release

Update release procedure
hannobraun · Mar 20, 2023 · ccebda5 · ccebda5
2 parents 6f2ae87 + b55c23e
commit ccebda5
Showing 1 changed file with 5 additions and 3 deletions.
diff --git a/release-procedure.md b/release-procedure.md
@@ -19,7 +19,7 @@ The release announcement lives on the website, and needs to be created in the [w
 
 First, create the initial draft of the release announcement:
 
-```
+``` sh
 automator announcement
 ```
 
@@ -41,7 +41,7 @@ When done, deploy to the website.
 
 In the main Fornjot repository, do this:
 
-```
+``` sh
 git switch -c release
 ```
 
@@ -70,7 +70,9 @@ Create a pull request:
 
 - Mention the version in the title (e.g. `Release v0.1.2`).
 - Label it as `release`.
-- Lock the pull request. Anything that updates this pull request (like comments), could confuse next week's release automation (because GitHub doesn't allow sorting pull requests by merge date, unfortunately).
+- Lock the pull request.
+
+The pull request needs to be locked, as anything that updates it (like comments), could confuse next week's release automation (because GitHub doesn't allow sorting pull requests by merge date, unfortunately).
 
 Once the CI build completed successfully, merge the pull request. The release automation will now compile binaries, create a release on GitHub, and publish to [crates.io](https://crates.io/).