Skip to content

Commit 71a3793

Browse files
docs: add CodeQL review steps and restructure after-release checklist
1 parent b5ddb96 commit 71a3793

1 file changed

Lines changed: 20 additions & 4 deletions

File tree

Collaboration.md

Lines changed: 20 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,10 @@ Releases are done by:
4646
- [ ] add label `mastermerge`
4747
- [ ] title of the PR is `Release 2.xx.0`
4848
- [ ] description of the PR is the body of the draft release with name `v2.xx.0`
49-
- [ ] check if the new PR has merge conflicts, if so, merge `master` into the new PR and solve the conflicts
49+
- [ ] review all `github-code-quality` / CodeQL review comments in the release PR (these comments are triggered automatically)
50+
- [ ] triage findings: if non-critical, continue the release; if critical and unclear, check with other maintainers and postpone the release if needed
51+
- [ ] if a finding is a false positive, dismiss it in the CodeQL alert with a short explanation
52+
- [ ] check if the new PR has merge conflicts; if so, merge `master` into the new PR and solve the conflicts
5053
- [ ] after PR tests run without issues, merge the PR
5154
- [ ] edit draft release with name `v2.xx.0`
5255
- [ ] set corresponding version tag `v2.xx.0` (with `Select tag` and then `Create new tag`)
@@ -62,9 +65,17 @@ Releases are done by:
6265

6366
### After release
6467

65-
- [ ] publish release notes with a link to the GitHub release on the forum in a new locked topic (use edit release on GitHub to copy the content with Markdown syntax)
66-
- [ ] close all issues with label `ready (coming with next release)`
67-
- [ ] release new documentation by merging `develop` into `master` in the documentation repository
68+
#### Documentation repository
69+
70+
- [ ] create a pull request from `develop` to `master` with title `Release v2.xx.0`
71+
- [ ] after successful test run via GitHub Actions: merge the pull request to `master`
72+
- [ ] verify the updated documentation site is live
73+
- [ ] create/publish a release in the documentation repository for the same version (`v2.xx.0`)
74+
- [ ] update `package.json` and `package-lock.json` in the `develop` branch to reflect the next version number `2.xx.0-develop`
75+
- [ ] commit and push `develop` branch
76+
77+
#### npm
78+
6879
- [ ] publish new version on [npm](https://www.npmjs.com/package/magicmirror)
6980
- [ ] use a clean environment (e.g. container)
7081
- [ ] clone this repository with the new `master` branch and `cd` into the local repository directory
@@ -83,3 +94,8 @@ Releases are done by:
8394
npm set "//registry.npmjs.org/:_authToken=$NPM_TOKEN"
8495
npm publish
8596
```
97+
98+
#### Housekeeping
99+
100+
- [ ] publish release notes with a link to the GitHub release on the forum in a new locked topic (use edit release on GitHub to copy the content with Markdown syntax)
101+
- [ ] close all issues with label `ready (coming with next release)` in both repositories

0 commit comments

Comments
 (0)