You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/release-procedure.md
+5-8Lines changed: 5 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,7 +8,6 @@ title: Release Procedure
8
8
Name | Description
9
9
---------- | -------
10
10
`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.
12
11
`UPSTREAM` | The Git remote for the main InspIRCd repository.
13
12
`VERSION` | The new release's version number.
14
13
@@ -19,18 +18,16 @@ Name | Description
19
18
0. Run `tools/mkheaders` to update the copyright headers.
20
19
0. If ABI breakages have been made then update `MODULE_ABI` in `include/moduledefs.h`.
21
20
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.`.
23
22
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`.
24
23
0. Tag the release with `git tag VERSION`.
25
24
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.
31
26
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).
33
27
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).
34
31
0. Update `INSP_VERSION` in the [Docker container build script](https://github.com/inspircd/docker/blob/master/.github/workflows/build-container.yml).
35
32
0. Update the topic in the InspIRCd IRC channels.
36
33
0. Post a link to the news post on the [InspIRCd social media accounts](/support).
0 commit comments