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: Collaboration.md
+20-4Lines changed: 20 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -46,7 +46,10 @@ Releases are done by:
46
46
-[ ] add label `mastermerge`
47
47
-[ ] title of the PR is `Release 2.xx.0`
48
48
-[ ] 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
50
53
-[ ] after PR tests run without issues, merge the PR
51
54
-[ ] edit draft release with name `v2.xx.0`
52
55
-[ ] set corresponding version tag `v2.xx.0` (with `Select tag` and then `Create new tag`)
@@ -62,9 +65,17 @@ Releases are done by:
62
65
63
66
### After release
64
67
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
+
68
79
-[ ] publish new version on [npm](https://www.npmjs.com/package/magicmirror)
69
80
-[ ] use a clean environment (e.g. container)
70
81
-[ ] clone this repository with the new `master` branch and `cd` into the local repository directory
- [ ] 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