docs for release
This commit is contained in:
parent
ec96fa0739
commit
847d3ddd1e
|
@ -149,7 +149,25 @@ The backend schema, models and records are stored using PouchDB when developing
|
|||
|
||||
### Publishing Budibase to NPM
|
||||
|
||||
You can publish all the latest versions of the monorepo packages by running:
|
||||
#### Testing In Electron
|
||||
|
||||
At budibase, we pride ourselves on giving our users a fast, native and slick local development experience. As a result, we use the electron to provide a native GUI for the budibase builder. In order to release budibase out into the wild, you should test your changes in a packaged electron application. To do this, first build budibase from the root directory.
|
||||
```
|
||||
yarn build
|
||||
```
|
||||
|
||||
Now everything is built, you can package up your electron application.
|
||||
```
|
||||
cd packages/server
|
||||
yarn build:electron
|
||||
```
|
||||
|
||||
Your new electron application will be stored in `packages/server/dist/<operating-system>`. Open up the executable and make sure everything is working smoothly.
|
||||
|
||||
|
||||
#### Publishing to NPM
|
||||
|
||||
Once you are happy that your changes work in electron, you can publish all the latest versions of the monorepo packages by running:
|
||||
|
||||
```
|
||||
yarn publishnpm
|
||||
|
@ -157,6 +175,10 @@ yarn publishnpm
|
|||
|
||||
from your root directory.
|
||||
|
||||
#### CI Release
|
||||
|
||||
After NPM has successfully published the budibase packages, a new tag will be pushed to master. This will kick off a github action (can be found at `.github/workflows/release.yml`) this will build and package the electron application for every OS (Windows, Mac, Linux). The binaries will be stored under the new tag on the [budibase releases page](https://github.com/Budibase/budibase/releases).
|
||||
|
||||
### Troubleshooting
|
||||
|
||||
Sometimes, things go wrong. This can be due to incompatible updates on the budibase platform. To clear down your development environment and start again:
|
||||
|
|
|
@ -29,5 +29,5 @@
|
|||
"uuid": "^7.0.3",
|
||||
"yargs": "^14.2.0"
|
||||
},
|
||||
"gitHead": "4a7edd9ebe702c93e8b9da2b74e814d3bb1266e1"
|
||||
"gitHead": "eff4fa93ca1db11b97b5fdedc0c488413e277eb8"
|
||||
}
|
||||
|
|
|
@ -52,7 +52,7 @@
|
|||
],
|
||||
"version": "0.1.8",
|
||||
"license": "MIT",
|
||||
"gitHead": "e4e053cb6ff9a0ddc7115b44ccaa24b8ec41fb9a",
|
||||
"gitHead": "eff4fa93ca1db11b97b5fdedc0c488413e277eb8",
|
||||
"dependencies": {
|
||||
"@material/card": "4.0.0"
|
||||
}
|
||||
|
|
|
@ -95,5 +95,5 @@
|
|||
"./scripts/jestSetup.js"
|
||||
]
|
||||
},
|
||||
"gitHead": "4a7edd9ebe702c93e8b9da2b74e814d3bb1266e1"
|
||||
"gitHead": "eff4fa93ca1db11b97b5fdedc0c488413e277eb8"
|
||||
}
|
||||
|
|
|
@ -35,7 +35,7 @@
|
|||
],
|
||||
"version": "0.1.8",
|
||||
"license": "MIT",
|
||||
"gitHead": "e4e053cb6ff9a0ddc7115b44ccaa24b8ec41fb9a",
|
||||
"gitHead": "eff4fa93ca1db11b97b5fdedc0c488413e277eb8",
|
||||
"dependencies": {
|
||||
"@beyonk/svelte-googlemaps": "^2.2.0",
|
||||
"fusioncharts": "^3.15.1-sr.1",
|
||||
|
|
Loading…
Reference in New Issue