Skip to content

Commit

Permalink
Merge pull request #1308 from matrix-org/j94/release-process
Browse files Browse the repository at this point in the history
Document release process in CONTRIBUTING.md
  • Loading branch information
Christian Paul authored Jun 4, 2021
2 parents 8e5bcad + 6f3a264 commit 98cc5bc
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 1 deletion.
18 changes: 18 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,3 +57,21 @@ new code.
directly onto the `package.json` (NPM) version.
- Releases are also tagged so they are present on the Releases page on Github.
- Releases should be signed by the maintainer's key.

### Doing a release

These steps are for the maintainers of the IRC bridge to refer to when doing a release.
When doing an RC release, suffix a `-rcV` to the tag and version but NOT the branch.

* `git checkout develop`
* `git pull`
* `git switch -c release-v0.V.0`
* update package.json version number
* `npm install` to update package-lock.json
* `./scripts/changelog-release.sh`
* `git commit CHANGELOG.md changelog.d package.json package-lock.json -m 'v0.V.0'`
* `git tag --sign --message 'v0.V.0' '0.V.0'`
* `git push origin release-v0.V.0`
* `git push origin 0.V.0`
* [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
* `npm publish`
1 change: 1 addition & 0 deletions changelog.d/1308.doc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Document release process in CONTRIBUTING.md
2 changes: 1 addition & 1 deletion spec/util/test.js
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ const main = proxyquire("../../lib/main.js", {
jasmine.getEnv().addReporter({
specStarted: function(result) {
console.log(result.fullName);
console.log(new Array(2 + result.fullName.length).join("="));
console.log("=".repeat(result.fullName.length + 1));
}
});

Expand Down

0 comments on commit 98cc5bc

Please sign in to comment.