Skip to content

Commit 98cc5bc

Browse files
author
Christian Paul
authored
Merge pull request #1308 from matrix-org/j94/release-process
Document release process in CONTRIBUTING.md
2 parents 8e5bcad + 6f3a264 commit 98cc5bc

File tree

3 files changed

+20
-1
lines changed

3 files changed

+20
-1
lines changed

CONTRIBUTING.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,3 +57,21 @@ new code.
5757
directly onto the `package.json` (NPM) version.
5858
- Releases are also tagged so they are present on the Releases page on Github.
5959
- Releases should be signed by the maintainer's key.
60+
61+
### Doing a release
62+
63+
These steps are for the maintainers of the IRC bridge to refer to when doing a release.
64+
When doing an RC release, suffix a `-rcV` to the tag and version but NOT the branch.
65+
66+
* `git checkout develop`
67+
* `git pull`
68+
* `git switch -c release-v0.V.0`
69+
* update package.json version number
70+
* `npm install` to update package-lock.json
71+
* `./scripts/changelog-release.sh`
72+
* `git commit CHANGELOG.md changelog.d package.json package-lock.json -m 'v0.V.0'`
73+
* `git tag --sign --message 'v0.V.0' '0.V.0'`
74+
* `git push origin release-v0.V.0`
75+
* `git push origin 0.V.0`
76+
* [Make a release on GitHub](https://github.com/matrix-org/matrix-appservice-irc/releases), copying the changelog into the body and marking it as pre-release
77+
* `npm publish`

changelog.d/1308.doc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Document release process in CONTRIBUTING.md

spec/util/test.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ const main = proxyquire("../../lib/main.js", {
2525
jasmine.getEnv().addReporter({
2626
specStarted: function(result) {
2727
console.log(result.fullName);
28-
console.log(new Array(2 + result.fullName.length).join("="));
28+
console.log("=".repeat(result.fullName.length + 1));
2929
}
3030
});
3131

0 commit comments

Comments
 (0)