mirror of
https://github.com/MichMich/MagicMirror.git
synced 2026-07-20 09:50:55 -07:00
docs: add CodeQL review steps and restructure after-release checklist (#4200)
After the last release, @rejas left some notes in the collaboration chat. This PR tries to address them. Additionally I went through the whole file and fixed some typos and formatting.
This commit is contained in:
Kristjan ESPERANTO
committed by
GitHub
GitHub
parent
df6170c596
commit
eab31fdbab
+41
-25
@@ -4,67 +4,78 @@ This document describes how collaborators of this repository should work togethe
|
||||
|
||||
## Pull Requests
|
||||
|
||||
- never merge your own PR's
|
||||
- never merge without someone having approved (approving and merging from same person is allowed)
|
||||
- never merge your own PRs
|
||||
- never merge without someone having approved (approving and merging by the same person is allowed)
|
||||
- wait for all approvals requested (or the author decides something different in the comments)
|
||||
- merge to `master` only for releases or other urgent issues (update notification is only triggered by tags)
|
||||
- merges to master should be tagged with the "mastermerge" label so that the test runs through
|
||||
- merges to `master` should be tagged with the `mastermerge` label so that the test runs through
|
||||
|
||||
## Issues
|
||||
|
||||
- "real" Issues are closed if the problem is solved and the fix is released
|
||||
- unrelated Issues (e.g. related to a foreign module) are closed immediately with a comment to open an issue in the module repository or to discuss this further in the forum or discord
|
||||
- "real" issues are closed if the problem is solved and the fix is released
|
||||
- unrelated issues (e.g. related to a third-party module) are closed immediately with a comment to open an issue in the module repository or to discuss this further in the forum or Discord
|
||||
|
||||
## Releases
|
||||
|
||||
Are done by
|
||||
Releases are done by:
|
||||
|
||||
- [ ] @rejas
|
||||
- [ ] @sdetweil
|
||||
- [ ] @khassel
|
||||
- [ ] @KristjanESPERANTO
|
||||
- @rejas
|
||||
- @sdetweil
|
||||
- @khassel or
|
||||
- @KristjanESPERANTO
|
||||
|
||||
### Pre-Deployment steps
|
||||
### Pre-Deployment Steps
|
||||
|
||||
- [ ] update dependencies (a few days before)
|
||||
|
||||
### Deployment steps
|
||||
### Deployment Steps
|
||||
|
||||
- [ ] pull latest `develop` branch
|
||||
- [ ] pull the latest `develop` branch
|
||||
- [ ] create `prep-release` branch from `develop`
|
||||
- [ ] update `package.json` and `package-lock.json` to reflect correct version number `2.xx.0`
|
||||
- [ ] test `prep-release` branch
|
||||
- [ ] commit and push all changes
|
||||
- [ ] create pull request from `prep-release` to `develop` branch with title `Prepare Release 2.xx.0`
|
||||
- [ ] after successful test run via github actions: merge pull request to `develop`
|
||||
- [ ] after successful test run via GitHub Actions: merge pull request to `develop`
|
||||
- [ ] review the content of the automatically generated draft release named `unreleased`
|
||||
- [ ] check contributor names
|
||||
- [ ] check auto generated min. node version and adjust it for better readability if necessary
|
||||
- [ ] check auto-generated minimum Node.js version and adjust it for better readability if necessary
|
||||
- [ ] check if all elements are assigned to the correct category
|
||||
- [ ] change release name to `v2.xx.0`
|
||||
- [ ] after successful test run via github actions: create pull request from `develop` to `master` branch
|
||||
- [ ] after successful test run via GitHub Actions: create pull request from `develop` to `master` branch
|
||||
- [ ] add label `mastermerge`
|
||||
- [ ] title of the PR is `Release 2.xx.0`
|
||||
- [ ] description of the PR is the body of the draft release with name `v2.xx.0`
|
||||
- [ ] check if new PR has merge conflicts, if so, merge `master` into the new PR and solve the conflicts
|
||||
- [ ] after PR tests run without issues, merge PR
|
||||
- [ ] review all `github-code-quality` / CodeQL review comments in the release PR (these comments are triggered automatically)
|
||||
- [ ] triage findings: if non-critical, continue the release; if critical and unclear, check with other maintainers and postpone the release if needed
|
||||
- [ ] if a finding is a false positive, dismiss it in the CodeQL alert with a short explanation
|
||||
- [ ] check if the new PR has merge conflicts; if so, merge `master` into the new PR and solve the conflicts
|
||||
- [ ] after PR tests run without issues, merge the PR
|
||||
- [ ] edit draft release with name `v2.xx.0`
|
||||
- [ ] set corresponding version tag `v2.xx.0` (with `Select tag` and then `Create new tag`)
|
||||
- [ ] update release link in `Compare to previous Release` by replacing `develop` with new tag `v2.xx.0`
|
||||
- [ ] update release link in `Compare to previous Release` by replacing `develop` with the new tag `v2.xx.0`
|
||||
- [ ] publish the release (button at the bottom)
|
||||
|
||||
### Draft new development release
|
||||
|
||||
- [ ] checkout `develop` branch
|
||||
- [ ] check out `develop` branch
|
||||
- [ ] update `package.json` and `package-lock.json` to reflect correct version number `2.xx.0-develop`
|
||||
- [ ] commit and push `develop` branch
|
||||
- [ ] if new release will be in January, update the year in LICENSE.md
|
||||
- [ ] if the new release will be in January, update the year in `LICENSE.md`
|
||||
|
||||
### After release
|
||||
|
||||
- [ ] publish release notes with link to github release on forum in new locked topic (use edit release on github to copy the content with markdown syntax)
|
||||
- [ ] close all issues with label `ready (coming with next release)`
|
||||
- [ ] release new documentation by merging `develop` on `master` in documentation repository
|
||||
#### Documentation repository
|
||||
|
||||
- [ ] create a pull request from `develop` to `master` with title `Release v2.xx.0`
|
||||
- [ ] after successful test run via GitHub Actions: merge the pull request to `master`
|
||||
- [ ] verify the updated documentation site is live
|
||||
- [ ] create/publish a release in the documentation repository for the same version (`v2.xx.0`)
|
||||
- [ ] update `package.json` and `package-lock.json` in the `develop` branch to reflect the next version number `2.xx.0-develop`
|
||||
- [ ] commit and push `develop` branch
|
||||
|
||||
#### npm
|
||||
|
||||
- [ ] publish new version on [npm](https://www.npmjs.com/package/magicmirror)
|
||||
- [ ] use a clean environment (e.g. container)
|
||||
- [ ] clone this repository with the new `master` branch and `cd` into the local repository directory
|
||||
@@ -74,7 +85,7 @@ Are done by
|
||||
- [ ] execute `npm publish`
|
||||
- [ ] **Method 2 (fallback for headless environments): With token (bypasses 2FA)**
|
||||
- [ ] ⚠️ Note: This method bypasses 2FA and should only be used when a browser is not available
|
||||
- [ ] goto `https://www.npmjs.com/settings/<username>/tokens/` and click `generate new token`
|
||||
- [ ] go to `https://www.npmjs.com/settings/<username>/tokens/` and click `generate new token`
|
||||
- [ ] enable `Bypass two-factor authentication (2FA)` and under `Packages and scopes` give `Read and write` permission to the `magicmirror` package, press `Generate token`
|
||||
- [ ] execute:
|
||||
|
||||
@@ -83,3 +94,8 @@ Are done by
|
||||
npm set "//registry.npmjs.org/:_authToken=$NPM_TOKEN"
|
||||
npm publish
|
||||
```
|
||||
|
||||
#### Housekeeping
|
||||
|
||||
- [ ] 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)
|
||||
- [ ] close all issues with label `ready (coming with next release)` in both repositories
|
||||
|
||||
Reference in New Issue
Block a user