mirror of https://github.com/nocodb/nocodb
Naveen MR
2 years ago
2 changed files with 124 additions and 43 deletions
@ -0,0 +1,124 @@
|
||||
--- |
||||
title: "NocoDB : Builds & Releases" |
||||
description: "Builds & Releases" |
||||
position: 3250 |
||||
category: "Engineering" |
||||
menuTitle: "Builds & Releases" |
||||
--- |
||||
|
||||
|
||||
## How to make a NocoDB release build ? |
||||
|
||||
- Click [NocoDB release action](https://github.com/nocodb/nocodb/actions/workflows/release-nocodb.yml) |
||||
- You should see the below screen |
||||
|
||||
 |
||||
- Change `Use workflow from` to `Branch: master`. If you choose the wrong branch, the workflow will be ended. |
||||
|
||||
 |
||||
- Then there would be two cases - you can either leave target tag and pervious tag blank or manually input some values |
||||
|
||||
> Target Tag means the target deployment version, while Previous Tag means the latest version as of now. Previous Tag is used for Release Note only - showing the file / commit differences between two tags. |
||||
|
||||
### Case 1: Leaving inputs blank |
||||
|
||||
- If Previous Tag is blank, then the value will be fetched from [latest](https://github.com/nocodb/nocodb/releases/latest) |
||||
- If Target Tag is blank, then the value will be Previous Tag plus one. Example: 0.90.11 (Previous Tag) + 1 = 0.90.12 (Target Tag) |
||||
|
||||
### Case 2: Manually Input |
||||
|
||||
Why? Sometimes we may mess up in NPM deployment. As NPM doesn't allow us to redeploy to the same tag again, in this case we cannot just use the previous tag + 1. Therefore, we need to use previous tag + 2 instead and we manually configure it. |
||||
|
||||
- After that, click `Run workflow` to start |
||||
- You can see Summary for the overall job status. |
||||
- Once `release-draft-note` and `release-executables` is finished, then go to [releases](https://github.com/nocodb/nocodb/releases), edit the draft note and save as draft for time being. |
||||
- Example: Adding header, update content if necessary, and click `Auto-generate release notes` to include more info. |
||||
- Once `release-docker` is finished, then test it locally first. You'll be expected to see `Upgrade Available` notification in UI as we haven't published the release note. (the version is retrieved from there) |
||||
- Once everything is finished, then publish the release note and the deployment is considered as DONE. |
||||
|
||||
## Jobs Explanations |
||||
|
||||
### validate-branch |
||||
|
||||
To check if `github.ref` is master. Otherwise, other branches will be not accepted. |
||||
|
||||
### process-input |
||||
|
||||
To enrich target tag or previous tag if necessary. |
||||
|
||||
### pr-to-master |
||||
|
||||
Automate a PR from develop to master branch so that we know the actual differences between the previous tag and the current tag. We choose master branch for a deployment base. |
||||
|
||||
### release-npm |
||||
|
||||
Build frontend and backend and release them to NPM. The changes during built such as version bumping will be committed and pushed to a temporary branch and an automated PR will be created and merged to master branch. |
||||
|
||||
Note that once you publish with a certain tag, you cannot publish with the same tag again. |
||||
|
||||
### release-draft-note |
||||
|
||||
Generate a draft release note. Some actions need to be done after this step. |
||||
|
||||
### release-docker |
||||
|
||||
Build docker image and publish it to Docker Hub. It may take around 15 - 30 mins. |
||||
|
||||
### close-issues |
||||
|
||||
Open issues marked with label `Status: Fixed` and `Status: Resolved` will be closed by bot automatically with comment mentioning the fix is included in which version. |
||||
|
||||
Example: |
||||
|
||||
 |
||||
|
||||
### publish-docs |
||||
|
||||
Publish Documentations |
||||
|
||||
### update-sdk-path |
||||
|
||||
`nocodb-sdk` is used in frontend and backend. However, in develop branch, the value would be `file:../nocodb-sdk` for development purpose (so that the changes done in nocodb-sdk in develop will be included in frontend and backend). During the deployment, the value will be changed to the target tag. This job is to update them back. |
||||
|
||||
### sync-to-develop |
||||
|
||||
Once the deployment is finished, there would be some new changes being pushed to master branch. This job is to sync the changes back to develop so that both branch won't have any difference. |
||||
|
||||
## What are daily builds & how are they built ? |
||||
> TODO |
||||
|
||||
## What are PR/timely builds & how are they built ? |
||||
NocoDB creates docker and binaries for each PR. |
||||
|
||||
This is to |
||||
- reduce pull request cycle time |
||||
- allow issue reporters / reviewers to verify the fix without setting up their local machines |
||||
|
||||
### Docker images |
||||
When a non-draft Pull Request is created, reopened or synchronized, a timely build for Docker would be triggered for the changes only included in the following paths. |
||||
|
||||
- `packages/nocodb-sdk/**` |
||||
- `packages/nc-gui/**` |
||||
- `packages/nc-plugin/**` |
||||
- `packages/nocodb/**` |
||||
|
||||
The docker images will be built and pushed to Docker Hub (See [nocodb/nocodb-timely](https://hub.docker.com/r/nocodb/nocodb-timely/tags) for the full list). Once the image is ready, Github bot will add a comment with the command in the pull request. The tag would be `<NOCODB_CURRENT_VERSION>-pr-<PR_NUMBER>-<YYYYMMDD>-<HHMM>`. |
||||
|
||||
 |
||||
|
||||
### Executables |
||||
|
||||
Similarly, we provide a timely build for executables for non-docker users. The source code will be built, packaged as binary files, and pushed to Github (See [nocodb/nocodb-timely](https://github.com/nocodb/nocodb-timely/releases) for the full list). |
||||
|
||||
Currently, we only support the following targets: |
||||
|
||||
- `node16-linux-arm64` |
||||
- `node16-macos-arm64` |
||||
- `node16-win-arm64` |
||||
- `node16-linux-x64` |
||||
- `node16-macos-x64` |
||||
- `node16-win-x64` |
||||
|
||||
Once the executables are ready, Github bot will add a comment with the commands in the pull request. |
||||
|
||||
 |
||||
@ -1,43 +0,0 @@
|
||||
--- |
||||
title: "Build on pull requests" |
||||
description: "Build on pull requests" |
||||
position: 3250 |
||||
category: "Engineering" |
||||
menuTitle: "Build on pull requests" |
||||
--- |
||||
|
||||
|
||||
NocoDB creates docker and binaries for each PR. |
||||
|
||||
This is to |
||||
- reduce pull request cycle time |
||||
- allow issue reporters / reviewers to verify the fix without setting up their local machines |
||||
|
||||
## Docker |
||||
When a non-draft Pull Request is created, reopened or synchronized, a timely build for Docker would be triggered for the changes only included in the following paths. |
||||
|
||||
- `packages/nocodb-sdk/**` |
||||
- `packages/nc-gui/**` |
||||
- `packages/nc-plugin/**` |
||||
- `packages/nocodb/**` |
||||
|
||||
The docker images will be built and pushed to Docker Hub (See [nocodb/nocodb-timely](https://hub.docker.com/r/nocodb/nocodb-timely/tags) for the full list). Once the image is ready, Github bot will add a comment with the command in the pull request. The tag would be `<NOCODB_CURRENT_VERSION>-pr-<PR_NUMBER>-<YYYYMMDD>-<HHMM>`. |
||||
|
||||
 |
||||
|
||||
## Executables |
||||
|
||||
Similarly, we provide a timely build for executables for non-docker users. The source code will be built, packaged as binary files, and pushed to Github (See [nocodb/nocodb-timely](https://github.com/nocodb/nocodb-timely/releases) for the full list). |
||||
|
||||
Currently, we only support the following targets: |
||||
|
||||
- `node16-linux-arm64` |
||||
- `node16-macos-arm64` |
||||
- `node16-win-arm64` |
||||
- `node16-linux-x64` |
||||
- `node16-macos-x64` |
||||
- `node16-win-x64` |
||||
|
||||
Once the executables are ready, Github bot will add a comment with the commands in the pull request. |
||||
|
||||
 |
||||
Loading…
Reference in new issue