Browse Source

docs: revise release steps

Signed-off-by: Wing-Kam Wong <wingkwong.code@gmail.com>
pull/1165/head
Wing-Kam Wong 3 years ago
parent
commit
31ed2941a5
  1. 34
      packages/noco-docs/content/en/engineering/publish.md

34
packages/noco-docs/content/en/engineering/publish.md

@ -6,10 +6,16 @@ category: "Engineering"
menuTitle: "Making a release" menuTitle: "Making a release"
--- ---
> This is exclusive to NocoDB team members only <alert>
This is exclusive to NocoDB team members only.
</alert>
<alert types='danger'>
The version 0.84.8 will be used as an example. Please change it during the release.
</alert>
## 1. Merge ```develop``` to ```master``` ## 1. Merge ```develop``` to ```master```
- When several features are included in develop branch and they are ready to be released, make a PR from `develop` branch to `master` branch. At least one NocoDB team member approval is required. - When several features are included in ``develop`` branch and they are ready to be released, make a PR with the title ``0.84.8 Pre-Release`` from `develop` branch to `master` branch. At least one NocoDB team member approval is required.
## 2. Publish frontend ## 2. Publish frontend
- Navigate to `packages/nc-gui` and execute following command. - Navigate to `packages/nc-gui` and execute following command.
@ -20,7 +26,7 @@ menuTitle: "Making a release"
- Install the latest published version of `nc-lib-gui` in `packages/nocodb`, package version can be extracted from result of step 1 or copy it from `packages/nc-lib-gui/package.json`. While installing, add `-E` to install exact version of the package. - Install the latest published version of `nc-lib-gui` in `packages/nocodb`, package version can be extracted from result of step 1 or copy it from `packages/nc-lib-gui/package.json`. While installing, add `-E` to install exact version of the package.
- Example: for latest published version `0.84.8` - Example: for latest published version `0.84.8`
```bash ```bash
npm i -E nc-lib-gui@0.84.8 npm i -E nc-lib-gui@0.84.8
``` ```
@ -31,11 +37,25 @@ menuTitle: "Making a release"
npm run obfuscate:build:publish npm run obfuscate:build:publish
``` ```
## 5. Prepare release notes ## 5. Close all issues
- Go to Issue page and close all issues with tags ``Fixed`` or ``Resolved``.
## 6. Commit release changes
- Commit those changes made by previous steps with the commit message ``chore(publish): v0.84.8``.
## 7. Prepare release notes
- Populate release note by running following github action (on `master` branch) - `Release : Draft Notes`. While running the action you have to provide 2 inputs: - Populate release note by running following github action (on `master` branch) - `Release : Draft Notes`. While running the action you have to provide 2 inputs:
- **Tag** : Provide current package version - **Tag** : Provide current package version
- **Previous Tag** : Provide previously released tag version - **Previous Tag** : Provide previously released tag version
## 6. Publish docker & release ## 8. Publish docker & release
- Publish docker image by running `Release : Docker` action in github (on `master` branch), where you have to provide the package version/tag. - Publish docker image by running `Release : Docker` action in github (on `master` branch), where you have to provide the package version/tag. It may take half an hour. Test it locally after it is done.
- Update the populated release (remove issues which is not related to release) draft and publish. In release note you can use `Auto-generate release notes` button to populate release content from commits & PR.
- Update the populated release (remove issues which is not related to release) draft and publish. In release note you can use `Auto-generate release notes` button to populate release content from commits & PR.
## 9. Sync the changes back to develop branch
- Pull the latest chagnes for both branches to your local
- Switch to ``develop`` branch
- Run ``git merge master``
- Push the diff to remote repository
Loading…
Cancel
Save