forked from DaRaFF/create-release-notes-checklist
-
Notifications
You must be signed in to change notification settings - Fork 0
/
checklist.js
45 lines (38 loc) · 3.18 KB
/
checklist.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
const getBody = (releaseName) => {
return `
**References**
* [Bug Dashboard](https://github.com/livingdocsIO/livingdocs-planning/projects/56)
* [Git repo for this checklist](https://github.com/livingdocsIO/create-release-notes-checklist)
**Budget**
* [ ]
# Code Freeze
* [ ] Create a major bump PR (e.g. 12.2.7 -> 12.3.0) to master for the server/editor/framework
\`\`\`
// create a bump pr (you don't have to be in the repo folder)
npx github:livingdocsIO/create-bump-pr --gh-token=<your-personal-gh-token> --gh-approval-token=<gh-livingdocs-automation-token> --owner=livingdocsio --repo=livingdocs-framework
\`\`\`
* [ ] Merge these PRs and wait for build to finish on master before continuing
* [ ] Announce and [create the upstream release branch](https://github.com/upfrontIO/team/blob/master/How-We-Work/Release-Process/Details/Create-Release-Branches.md) for the server/editor/framework
* [ ] Update the framework version of the upstream editor/server in \`${releaseName}\` branch
\`\`\`
// change the framework version in editor/server to the release alias e.g. release-2020-12
package.json -> "@livingdocs/framework": "release-2020-12"
// update the package-lock.json
npm update @livingdocs/framework
\`\`\`
* [ ] Get a list of new Documentation Guides based on the diff between the last 2 releases and give that info to the Marketing team -> \`git diff origin/master@{"06.12.2022"} origin/master -- ./content/guides\`
# Release Notes
* [ ] Switch the release config to the next release [see example commit](https://github.com/livingdocsIO/documentation/commit/45d40c711bd75d38edd35cdfec976bce3eb50ddb) but check if the relase notes document already exist!
# NZZ
* Check if the downstream integration branch of the **PREVIOUS** release are in a correct state
* [ ] Check and update the integration notes
* [ ] [Create downstream integration](https://github.com/upfrontIO/team/blob/master/How-We-Work/Release-Process/Details/Integration-Branches.md) branches of the next release for the NZZ (branch name: upstream-release-MMMM-YY) for the [nzz server](https://github.com/nzzdev/livingdocs-api) and [nzz editor](https://github.com/nzzdev/livingdocs-editor)
* [ ] Update server/editor package versions on the integration branch to the latest master tag of the upstream server/editor
* [ ] Update \`defaultBranch\` and \`customBranches\` of livingdocs-integration.json on master of the [server](https://github.com/upfrontIO/livingdocs-server/blob/master/livingdocs-integration.json)/[editor](https://github.com/upfrontIO/livingdocs-editor/blob/master/livingdocs-integration.json)
* [ ] Update \`defaultBranch\` and \`customBranches\` of livingdocs-integration.json on \`${releaseName}\` branch of the [framework](https://github.com/upfrontIO/livingdocs-framework/blob/master/livingdocs-integration.json)
* [ ] Attention: the \`defaultBranch\` in livingdocs-integration.json of the release branch in the framework must be set to the current release after creating the release branch e.g. [example](https://github.com/livingdocsIO/livingdocs-framework/blob/release-2020-05/livingdocs-integration.json#L4)
`
}
module.exports = {
getBody: getBody
}