From c35e983407f876a5077833e2b178e6a19f9f7664 Mon Sep 17 00:00:00 2001 From: Wing-Kam Wong Date: Fri, 28 Jan 2022 13:50:27 +0800 Subject: [PATCH] docs: revise publish steps --- .../content/en/setup-and-usages/publish.md | 35 ++++++++++++------- 1 file changed, 22 insertions(+), 13 deletions(-) diff --git a/packages/noco-docs/content/en/setup-and-usages/publish.md b/packages/noco-docs/content/en/setup-and-usages/publish.md index b60e00923c..86f2dc56a5 100644 --- a/packages/noco-docs/content/en/setup-and-usages/publish.md +++ b/packages/noco-docs/content/en/setup-and-usages/publish.md @@ -6,29 +6,38 @@ category: "Usage" menuTitle: "Publishing Packages" --- +> This is exclusive to NocoDB team members only + ## Steps -1. Navigate to `packages/nc-gui` and execute following command. - ``` +1. When several features are included in develop branch and they are ready to be released, make a PR from `deveop` branach to `master` branch. At least one NocoDB team member approval is required. + +2. Navigate to `packages/nc-gui` and execute following command. + + ```bash npm run build:copy:jsdeliver ``` -2. Install the latest published version of `nc-lig-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: +3. Install the latest published version of `nc-lig-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: latest published version `0.84.8` + + ```bash npm i -E nc-lib-gui@0.84.8 - ``` -3. Update package version in `packages/nocodb/package.json` file. + ``` + +4. Update package version in `packages/nocodb/package.json` file. + +5. Publish the npm package by running following npm command in `packages/nocodb` folder. -4. Commit and push changes to develop branch. -5. Raise a release pull request. -6. After merging develop branch to master publish the npm package by running following npm command in `packages/nocodb` folder. ``` npm run obfuscate:build:publish ``` -7. Populate release not by running following github action(on `master` branch) - `Release : Draft Notes`. While running the action you have to provide 2 inputs: + +6. 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 - **Previous Tag** : Provide previously released tag version -8. Publish docker image by running `Release : Docker` action in github(on `master` branch), where you have to provide the package version/tag. -9. Finally update the populated release(remove issues which is not related to release) draft not and publish. In release not you can use `Auto-generate release notes` button to populate release content from commits & PR. \ No newline at end of file + +7. Publish docker image by running `Release : Docker` action in github (on `master` branch), where you have to provide the package version/tag. + +8. Finally update the populated release (remove issues which is not related to release) draft not and publish. In release note you can use `Auto-generate release notes` button to populate release content from commits & PR. \ No newline at end of file