mirror of https://github.com/nocodb/nocodb
Naveen MR
2 years ago
25 changed files with 16897 additions and 85 deletions
@ -1,9 +1,9 @@
|
||||
--- |
||||
title: 'How to access APIs ?' |
||||
description: 'How to access APIs ?' |
||||
position: 100 |
||||
title: 'Accessing APIs' |
||||
description: 'Accessing APIs' |
||||
position: 1000 |
||||
category: 'Developer Resources' |
||||
menuTitle: 'How to access APIs ?' |
||||
menuTitle: 'Accessing APIs' |
||||
--- |
||||
|
||||
## REST APIs |
||||
@ -1,6 +1,6 @@
|
||||
--- |
||||
title: 'REST APIs' |
||||
position: 200 |
||||
position: 1010 |
||||
category: 'Developer Resources' |
||||
menuTitle: 'REST APIs' |
||||
--- |
||||
@ -1,6 +1,6 @@
|
||||
--- |
||||
title: 'GraphQL APIs' |
||||
position: 300 |
||||
position: 1020 |
||||
category: 'Developer Resources' |
||||
menuTitle: 'GraphQL APIs' |
||||
--- |
||||
@ -1,7 +1,7 @@
|
||||
--- |
||||
title: 'Webhooks' |
||||
description: 'Webhooks' |
||||
position: 400 |
||||
position: 1030 |
||||
category: 'Developer Resources' |
||||
menuTitle: 'Webhooks' |
||||
--- |
||||
@ -1,7 +1,7 @@
|
||||
--- |
||||
title: 'API Tokens' |
||||
description: 'API Tokens' |
||||
position: 500 |
||||
position: 1040 |
||||
category: 'Developer Resources' |
||||
menuTitle: 'API Tokens' |
||||
--- |
||||
@ -0,0 +1,41 @@
|
||||
--- |
||||
title: "Making a release" |
||||
description: "Making a release" |
||||
position: 2000 |
||||
category: "Engineering" |
||||
menuTitle: "Making a release" |
||||
--- |
||||
|
||||
> This is exclusive to NocoDB team members only |
||||
|
||||
## 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. |
||||
|
||||
## 2. Publish frontend |
||||
- Navigate to `packages/nc-gui` and execute following command. |
||||
```bash |
||||
npm run build:copy:jsdeliver |
||||
``` |
||||
## 3. Install frontend |
||||
- 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` |
||||
```bash |
||||
npm i -E nc-lib-gui@0.84.8 |
||||
``` |
||||
|
||||
## 4. Publish backend |
||||
- Bump package version in `packages/nocodb/package.json` file. |
||||
- Publish the npm package by running following npm command in `packages/nocodb` folder. |
||||
``` |
||||
npm run obfuscate:build:publish |
||||
``` |
||||
|
||||
## 5. 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: |
||||
- **Tag** : Provide current package version |
||||
- **Previous Tag** : Provide previously released tag version |
||||
|
||||
## 6. 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. |
||||
- 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. |
||||
@ -1,7 +1,7 @@
|
||||
--- |
||||
title: 'Installation' |
||||
description: 'Simple installation - takes about three minutes!' |
||||
position: 1 |
||||
position: 10 |
||||
category: 'Getting started' |
||||
menuTitle: 'Installation' |
||||
link: https://codesandbox.io/embed/vigorous-firefly-80kq5?hidenavigation=1&theme=dark |
||||
@ -1,7 +1,7 @@
|
||||
--- |
||||
title: 'Upgrading' |
||||
description: 'Upgrading NocoDB : Docker, npm, Heroku!' |
||||
position: 2 |
||||
position: 20 |
||||
category: 'Getting started' |
||||
menuTitle: 'Upgrading' |
||||
link: https://codesandbox.io/embed/vigorous-firefly-80kq5?hidenavigation=1&theme=dark |
||||
@ -1,7 +1,7 @@
|
||||
--- |
||||
title: 'Demos' |
||||
description: 'Demos' |
||||
position: 3 |
||||
position: 30 |
||||
category: 'Getting started' |
||||
fullscreen: true |
||||
menuTitle: 'Demos' |
||||
@ -1,7 +1,7 @@
|
||||
--- |
||||
title: 'Dashboard' |
||||
description: 'Dashboard' |
||||
position: 10 |
||||
position: 500 |
||||
category: 'Usage' |
||||
menuTitle: 'Dashboard' |
||||
--- |
||||
@ -1,7 +1,7 @@
|
||||
--- |
||||
title: "Table Operations" |
||||
description: "Table Operations" |
||||
position: 20 |
||||
position: 510 |
||||
category: "Usage" |
||||
menuTitle: "Table Operations" |
||||
--- |
||||
@ -1,7 +1,7 @@
|
||||
--- |
||||
title: 'Column Types' |
||||
description: 'Column Types' |
||||
position: 30 |
||||
position: 520 |
||||
category: 'Usage' |
||||
menuTitle: 'Column Types' |
||||
--- |
||||
@ -1,7 +1,7 @@
|
||||
--- |
||||
title: "Column Operations" |
||||
description: "Column Operations" |
||||
position: 35 |
||||
position: 530 |
||||
category: "Usage" |
||||
menuTitle: "Column Operations" |
||||
--- |
||||
@ -1,7 +1,7 @@
|
||||
--- |
||||
title: "Link To Another Record" |
||||
description: "Link To Another Record" |
||||
position: 39 |
||||
position: 540 |
||||
category: "Usage" |
||||
menuTitle: "Link To Another Record" |
||||
--- |
||||
@ -1,7 +1,7 @@
|
||||
--- |
||||
title: "Lookup" |
||||
description: "Lookup" |
||||
position: 41 |
||||
position: 550 |
||||
category: "Usage" |
||||
menuTitle: "Lookup" |
||||
--- |
||||
@ -1,7 +1,7 @@
|
||||
--- |
||||
title: "Rollup" |
||||
description: "Rollup" |
||||
position: 42 |
||||
position: 560 |
||||
category: "Usage" |
||||
menuTitle: "Rollup" |
||||
--- |
||||
@ -1,7 +1,7 @@
|
||||
--- |
||||
title: "Formulas" |
||||
description: "Formulas" |
||||
position: 43 |
||||
position: 580 |
||||
category: "Usage" |
||||
menuTitle: "Formulas" |
||||
--- |
||||
@ -1,7 +1,7 @@
|
||||
--- |
||||
title: 'Audit' |
||||
description: 'Audit log' |
||||
position: 50 |
||||
position: 590 |
||||
category: 'Usage' |
||||
menuTitle: 'Audit' |
||||
--- |
||||
@ -1,7 +1,7 @@
|
||||
--- |
||||
title: 'Metadata' |
||||
description: 'Metadata' |
||||
position: 60 |
||||
position: 600 |
||||
category: 'Usage' |
||||
menuTitle: 'Metadata' |
||||
--- |
||||
@ -1,7 +1,7 @@
|
||||
--- |
||||
title: 'Sync Schema' |
||||
description: 'Schema changes made to database from outside nocodb GUI can be synced' |
||||
position: 70 |
||||
position: 610 |
||||
category: 'Usage' |
||||
menuTitle: 'Sync Schema' |
||||
--- |
||||
@ -1,9 +1,9 @@
|
||||
--- |
||||
title: 'User Management - Team & Auth Roles & Permissions' |
||||
title: 'Team & Auth' |
||||
description: 'Breakdown of roles & permissions for team user management' |
||||
position: 44 |
||||
position: 620 |
||||
category: 'Usage' |
||||
menuTitle: 'User Management - Team & Auth Roles & Permissions' |
||||
menuTitle: 'Team & Auth' |
||||
--- |
||||
|
||||
|
||||
@ -1,43 +0,0 @@
|
||||
--- |
||||
title: "Publishing Packages" |
||||
description: "Publishing Packages" |
||||
position: 100 |
||||
category: "Usage" |
||||
menuTitle: "Publishing Packages" |
||||
--- |
||||
|
||||
> This is exclusive to NocoDB team members only |
||||
|
||||
## Steps |
||||
|
||||
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 |
||||
``` |
||||
|
||||
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 |
||||
``` |
||||
|
||||
4. Update package version in `packages/nocodb/package.json` file. |
||||
|
||||
5. Publish the npm package by running following npm command in `packages/nocodb` folder. |
||||
|
||||
``` |
||||
npm run obfuscate:build:publish |
||||
``` |
||||
|
||||
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 |
||||
|
||||
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. |
||||
File diff suppressed because it is too large
Load Diff
Loading…
Reference in new issue