Skip to content

Commit 5adb6bd

Browse files
committed
Modernize the release procedure.
1 parent e5b4d8c commit 5adb6bd

1 file changed

Lines changed: 5 additions & 8 deletions

File tree

docs/release-procedure.md

Lines changed: 5 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,6 @@ title: Release Procedure
88
Name | Description
99
---------- | -------
1010
`BRANCH` | The branch on which the release is happening.
11-
`PREVIOUS` | The previous release's version number or the previous branch if the release is the first on that branch.
1211
`UPSTREAM` | The Git remote for the main InspIRCd repository.
1312
`VERSION` | The new release's version number.
1413

@@ -19,18 +18,16 @@ Name | Description
1918
0. Run `tools/mkheaders` to update the copyright headers.
2019
0. If ABI breakages have been made then update `MODULE_ABI` in `include/moduledefs.h`.
2120
0. Update the version in `src/version.sh`.
22-
0. Commit the changes to `include/moduledefs.h` and `src/version.sh`.
21+
0. Commit the changes to `include/moduledefs.h` and `src/version.sh` with the message `Release VERSION.`.
2322
0. Ensure that the branch tip builds with no warnings. Checking [GitHub Actions](https://github.com/inspircd/inspircd/actions) is helpful as it builds with `-Werror`.
2423
0. Tag the release with `git tag VERSION`.
2524
0. Run `git push UPSTREAM BRANCH` and `git push UPSTREAM VERSION`.
26-
0. Add a [GitHub release](https://github.com/inspircd/inspircd/tags) for the VERSION on tag.
27-
0. Generate a list of contributors for the news post using `git log --pretty=' - %aN' PREVIOUS...VERSION | sort -fu`
28-
0. Create a news post on the website using the list of contributors from the previous step.
29-
0. Mark the new news post as featured and unmark the old one.
30-
0. If the release is stable then update `misc.currentVersion` in the website config to VERSION.
25+
0. Add a [GitHub release](https://github.com/inspircd/inspircd/tags) for the VERSION tag.
3126
0. Update the change log on the documentation site.
32-
0. Run the [API documentation workflow](https://github.com/inspircd/api-docs/actions/workflows/build.yml).
3327
0. If the release fixes a security vulnerability then create an advisory on the documentation site.
28+
0. Create a news post on the website using the change log from the previous step.
29+
0. Mark the new news post as featured and unmark the previous one.
30+
0. Run the [API documentation workflow](https://github.com/inspircd/api-docs/actions/workflows/build.yml).
3431
0. Update `INSP_VERSION` in the [Docker container build script](https://github.com/inspircd/docker/blob/master/.github/workflows/build-container.yml).
3532
0. Update the topic in the InspIRCd IRC channels.
3633
0. Post a link to the news post on the [InspIRCd social media accounts](/support).

0 commit comments

Comments
 (0)