Update docs
This commit is contained in:
Adria Navarro
parent
5bef8fc607
commit
02f836d0cf
|
|
@ -1,194 +0,0 @@
|
||||||
{
|
|
||||||
"files": [
|
|
||||||
"README.md"
|
|
||||||
],
|
|
||||||
"imageSize": 100,
|
|
||||||
"commit": false,
|
|
||||||
"contributors": [
|
|
||||||
{
|
|
||||||
"login": "shogunpurple",
|
|
||||||
"name": "Martin McKeaveney",
|
|
||||||
"avatar_url": "https://avatars1.githubusercontent.com/u/11256663?v=4",
|
|
||||||
"profile": "http://martinmck.com",
|
|
||||||
"contributions": [
|
|
||||||
"code",
|
|
||||||
"doc",
|
|
||||||
"test",
|
|
||||||
"infra"
|
|
||||||
]
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"login": "mike12345567",
|
|
||||||
"name": "Michael Drury",
|
|
||||||
"avatar_url": "https://avatars2.githubusercontent.com/u/4407001?v=4",
|
|
||||||
"profile": "http://www.michaeldrury.co.uk/",
|
|
||||||
"contributions": [
|
|
||||||
"doc",
|
|
||||||
"code",
|
|
||||||
"test",
|
|
||||||
"infra"
|
|
||||||
]
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"login": "aptkingston",
|
|
||||||
"name": "Andrew Kingston",
|
|
||||||
"avatar_url": "https://avatars3.githubusercontent.com/u/9075550?v=4",
|
|
||||||
"profile": "https://github.com/aptkingston",
|
|
||||||
"contributions": [
|
|
||||||
"doc",
|
|
||||||
"code",
|
|
||||||
"test",
|
|
||||||
"design"
|
|
||||||
]
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"login": "mjashanks",
|
|
||||||
"name": "Michael Shanks",
|
|
||||||
"avatar_url": "https://avatars3.githubusercontent.com/u/3524181?v=4",
|
|
||||||
"profile": "https://budibase.com/",
|
|
||||||
"contributions": [
|
|
||||||
"doc",
|
|
||||||
"code",
|
|
||||||
"test"
|
|
||||||
]
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"login": "kevmodrome",
|
|
||||||
"name": "Kevin Åberg Kultalahti",
|
|
||||||
"avatar_url": "https://avatars3.githubusercontent.com/u/534488?v=4",
|
|
||||||
"profile": "https://github.com/kevmodrome",
|
|
||||||
"contributions": [
|
|
||||||
"doc",
|
|
||||||
"code",
|
|
||||||
"test"
|
|
||||||
]
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"login": "joebudi",
|
|
||||||
"name": "Joe",
|
|
||||||
"avatar_url": "https://avatars2.githubusercontent.com/u/49767913?v=4",
|
|
||||||
"profile": "https://www.budibase.com/",
|
|
||||||
"contributions": [
|
|
||||||
"doc",
|
|
||||||
"code",
|
|
||||||
"content",
|
|
||||||
"design"
|
|
||||||
]
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"login": "Rory-Powell",
|
|
||||||
"name": "Rory Powell",
|
|
||||||
"avatar_url": "https://avatars.githubusercontent.com/u/8755148?v=4",
|
|
||||||
"profile": "https://github.com/Rory-Powell",
|
|
||||||
"contributions": [
|
|
||||||
"code",
|
|
||||||
"doc",
|
|
||||||
"test"
|
|
||||||
]
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"login": "PClmnt",
|
|
||||||
"name": "Peter Clement",
|
|
||||||
"avatar_url": "https://avatars.githubusercontent.com/u/5665926?v=4",
|
|
||||||
"profile": "https://github.com/PClmnt",
|
|
||||||
"contributions": [
|
|
||||||
"code",
|
|
||||||
"doc",
|
|
||||||
"test"
|
|
||||||
]
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"login": "Conor-Mack",
|
|
||||||
"name": "Conor_Mack",
|
|
||||||
"avatar_url": "https://avatars1.githubusercontent.com/u/36074859?v=4",
|
|
||||||
"profile": "https://github.com/Conor-Mack",
|
|
||||||
"contributions": [
|
|
||||||
"code",
|
|
||||||
"test"
|
|
||||||
]
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"login": "pngwn",
|
|
||||||
"name": "pngwn",
|
|
||||||
"avatar_url": "https://avatars1.githubusercontent.com/u/12937446?v=4",
|
|
||||||
"profile": "https://github.com/pngwn",
|
|
||||||
"contributions": [
|
|
||||||
"code",
|
|
||||||
"test"
|
|
||||||
]
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"login": "HugoLd",
|
|
||||||
"name": "HugoLd",
|
|
||||||
"avatar_url": "https://avatars0.githubusercontent.com/u/26521848?v=4",
|
|
||||||
"profile": "https://github.com/HugoLd",
|
|
||||||
"contributions": [
|
|
||||||
"code"
|
|
||||||
]
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"login": "victoriasloan",
|
|
||||||
"name": "victoriasloan",
|
|
||||||
"avatar_url": "https://avatars.githubusercontent.com/u/9913651?v=4",
|
|
||||||
"profile": "https://github.com/victoriasloan",
|
|
||||||
"contributions": [
|
|
||||||
"code"
|
|
||||||
]
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"login": "yashank09",
|
|
||||||
"name": "yashank09",
|
|
||||||
"avatar_url": "https://avatars.githubusercontent.com/u/37672190?v=4",
|
|
||||||
"profile": "https://github.com/yashank09",
|
|
||||||
"contributions": [
|
|
||||||
"code"
|
|
||||||
]
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"login": "SOVLOOKUP",
|
|
||||||
"name": "SOVLOOKUP",
|
|
||||||
"avatar_url": "https://avatars.githubusercontent.com/u/53158137?v=4",
|
|
||||||
"profile": "https://github.com/SOVLOOKUP",
|
|
||||||
"contributions": [
|
|
||||||
"code"
|
|
||||||
]
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"login": "seoulaja",
|
|
||||||
"name": "seoulaja",
|
|
||||||
"avatar_url": "https://avatars.githubusercontent.com/u/15101654?v=4",
|
|
||||||
"profile": "https://github.com/seoulaja",
|
|
||||||
"contributions": [
|
|
||||||
"translation"
|
|
||||||
]
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"login": "mslourens",
|
|
||||||
"name": "Maurits Lourens",
|
|
||||||
"avatar_url": "https://avatars.githubusercontent.com/u/1907152?v=4",
|
|
||||||
"profile": "https://github.com/mslourens",
|
|
||||||
"contributions": [
|
|
||||||
"test",
|
|
||||||
"code"
|
|
||||||
]
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"login": "Rory-Powell",
|
|
||||||
"name": "Rory Powell",
|
|
||||||
"avatar_url": "https://avatars.githubusercontent.com/u/8755148?v=4",
|
|
||||||
"profile": "https://github.com/Rory-Powell",
|
|
||||||
"contributions": [
|
|
||||||
"infra",
|
|
||||||
"test",
|
|
||||||
"code"
|
|
||||||
]
|
|
||||||
}
|
|
||||||
],
|
|
||||||
"contributorsPerLine": 7,
|
|
||||||
"projectName": "budibase",
|
|
||||||
"projectOwner": "Budibase",
|
|
||||||
"repoType": "github",
|
|
||||||
"repoHost": "https://github.com",
|
|
||||||
"skipCi": true,
|
|
||||||
"commitConvention": "none"
|
|
||||||
}
|
|
||||||
|
|
@ -1,136 +1,43 @@
|
||||||
# Budibase CI Pipelines
|
# Budibase CI Pipelines
|
||||||
|
|
||||||
Welcome to the budibase CI pipelines directory. This document details what each of the CI pipelines are for, and come common combinations.
|
Welcome to the Budibase CI pipelines directory. This document details what each of the CI pipelines are for, and come common combinations.
|
||||||
|
|
||||||
## All CI Pipelines
|
## All CI Pipelines
|
||||||
|
|
||||||
### Note
|
|
||||||
|
|
||||||
- When running workflow dispatch jobs, ensure you always run them off the `master` branch. It defaults to `develop`, so double check before running any jobs. The exception to this case is the `deploy-release` job which requires the develop branch.
|
|
||||||
|
|
||||||
### Standard CI Build Job (budibase_ci.yml)
|
### Standard CI Build Job (budibase_ci.yml)
|
||||||
|
|
||||||
Triggers:
|
Triggers:
|
||||||
|
|
||||||
- PR or push to develop
|
|
||||||
- PR or push to master
|
- PR or push to master
|
||||||
|
|
||||||
The standard CI Build job is what runs when you raise a PR to develop or master.
|
The standard CI Build job is what runs when you raise a PR to master.
|
||||||
|
|
||||||
- Installs all dependencies,
|
- Installs all dependencies,
|
||||||
- builds the project
|
- builds the project
|
||||||
- run the unit tests
|
- run the unit tests
|
||||||
- Generate test coverage metrics with codecov
|
- Generate test coverage metrics with codecov
|
||||||
- Run the integration tests
|
- Run the integration tests
|
||||||
|
- Check that the pro and account portal submodules are pointing to the lastest master head
|
||||||
|
|
||||||
### Release Develop Job (release-develop.yml)
|
### Release Job (tag-release.yml)
|
||||||
|
|
||||||
Triggers:
|
Triggers:
|
||||||
|
|
||||||
- Push to develop
|
- Manually triggered
|
||||||
|
|
||||||
The job responsible for building, tagging and pushing docker images out to the test and release environments.
|
This job is responsible for building and pushing all the production services, packages and images. This is done via [budibase-deploys](https://github.com/Budibase/budibase-deploys/actions/workflows/release.yml).
|
||||||
|
|
||||||
- Installs all dependencies
|
An input is required, indicating if the new version will be a `patch`, `minor` or `major` bump.
|
||||||
- builds the project
|
|
||||||
- run the unit tests
|
|
||||||
- publish the budibase JS packages under a prerelease tag to NPM
|
|
||||||
- build, tag and push docker images under the `develop` tag to docker hub
|
|
||||||
|
|
||||||
These images will then be pulled by the test and release environments, updating the latest automatically. Discord notifications are sent to the #infra channel when this occurs.
|
More documentation can be found in here: https://budibase.atlassian.net/wiki/spaces/DEVOPS/pages/347930625/Production+release
|
||||||
|
|
||||||
### Release Job (release.yml)
|
|
||||||
|
|
||||||
Triggers:
|
|
||||||
|
|
||||||
- Push to master
|
|
||||||
|
|
||||||
This job is responsible for building and pushing the latest code to NPM and docker hub, so that it can be deployed.
|
|
||||||
|
|
||||||
- Installs all dependencies
|
|
||||||
- builds the project
|
|
||||||
- run the unit tests
|
|
||||||
- publish the budibase JS packages under a release tag to NPM (always incremented by patch versions)
|
|
||||||
- build, tag and push docker images under the `v.x.x.x` (the tag of the NPM release) tag to docker hub
|
|
||||||
|
|
||||||
### Release Selfhost Job (release-selfhost.yml)
|
|
||||||
|
|
||||||
Triggers:
|
|
||||||
|
|
||||||
- Manual Workflow Dispatch Trigger
|
|
||||||
|
|
||||||
This job is responsible for delivering the latest version of budibase to those that are self-hosting.
|
|
||||||
|
|
||||||
This job relies on the release job to have run first, so the latest image is pushed to dockerhub. This job then will pull the latest version from `lerna.json` and try to find an image in dockerhub corresponding to that version. For example, if the version in `lerna.json` is `1.0.0`:
|
|
||||||
|
|
||||||
- Pull the images for all budibase services tagged `v1.0.0` from dockerhub
|
|
||||||
- Tag these images as `latest`
|
|
||||||
- Push them back to dockerhub. This now means anyone who pulls `latest` (self hosters using docker-compose) will get the latest version.
|
|
||||||
- Build and release the budibase helm chart for kubernetes users
|
|
||||||
- Perform a github release with the latest version. You can see previous releases here (https://github.com/Budibase/budibase/releases)
|
|
||||||
|
|
||||||
### Deploy Release (deploy-release.yml)
|
|
||||||
|
|
||||||
Triggers:
|
|
||||||
|
|
||||||
- Manual Workflow Dispatch Trigger
|
|
||||||
|
|
||||||
This job is responsible for deploying to our release, cloud kubernetes environment. You must run the release job first, to ensure that the latest images have been built and pushed to docker hub. After kicking off this job, the following will occur:
|
|
||||||
|
|
||||||
- Checks out the release branch
|
|
||||||
- Pulls the latest `values.yaml` from budibase infra, a private repo containing budibases infrastructure configuration
|
|
||||||
- Gets the latest budibase version from `lerna.json`, if it hasn't been specified in the workflow when you kicked it off
|
|
||||||
- Configures AWS Credentials
|
|
||||||
- Deploys the helm chart in the budibase repo to our preproduction EKS cluster, injecting the `values.yaml` we pulled from budibase-infra
|
|
||||||
- Fires off a discord webhook in the #infra channel to show that the deployment completely successfully.
|
|
||||||
|
|
||||||
### Deploy Preprod (deploy-preprod.yml)
|
|
||||||
|
|
||||||
Triggers:
|
|
||||||
|
|
||||||
- Manual Workflow Dispatch Trigger
|
|
||||||
|
|
||||||
This job is responsible for deploying to our preprod, cloud kubernetes environment. You must run the release job first, to ensure that the latest images have been built and pushed to docker hub. After kicking off this job, the following will occur:
|
|
||||||
|
|
||||||
- Checks out the master branch
|
|
||||||
- Pulls the latest `values.yaml` from budibase infra, a private repo containing budibases infrastructure configuration
|
|
||||||
- Gets the latest budibase version from `lerna.json`, if it hasn't been specified in the workflow when you kicked it off
|
|
||||||
- Configures AWS Credentials
|
|
||||||
- Deploys the helm chart in the budibase repo to our preprod EKS cluster, injecting the `values.yaml` we pulled from budibase-infra
|
|
||||||
- Fires off a discord webhook in the #infra channel to show that the deployment completely successfully.
|
|
||||||
|
|
||||||
### Deploy Production (deploy-cloud.yml)
|
|
||||||
|
|
||||||
Triggers:
|
|
||||||
|
|
||||||
- Manual Workflow Dispatch Trigger
|
|
||||||
|
|
||||||
This job is responsible for deploying to our production, cloud kubernetes environment. You must run the release job first, to ensure that the latest images have been built and pushed to docker hub. You can also manually enter a version number for this job, so you can perform rollbacks or upgrade to a specific version. After kicking off this job, the following will occur:
|
|
||||||
|
|
||||||
- Checks out the master branch
|
|
||||||
- Pulls the latest `values.yaml` from budibase infra, a private repo containing budibases infrastructure configuration
|
|
||||||
- Gets the latest budibase version from `lerna.json`, if it hasn't been specified in the workflow when you kicked it off
|
|
||||||
- Configures AWS Credentials
|
|
||||||
- Deploys the helm chart in the budibase repo to our production EKS cluster, injecting the `values.yaml` we pulled from budibase-infra
|
|
||||||
- Fires off a discord webhook in the #infra channel to show that the deployment completely successfully.
|
|
||||||
|
|
||||||
## Common Workflows
|
## Common Workflows
|
||||||
|
|
||||||
### Deploy Changes to Production (Release)
|
### Deploy Changes to Production (Release)
|
||||||
|
|
||||||
- Merge `develop` into `master`
|
- Merge your changes into `master`
|
||||||
- Wait for budibase CI job and release job to run
|
- Run `tag-release.yml`
|
||||||
- Run cloud deploy job
|
- Check the progress in [budibase-deploys](https://github.com/Budibase/budibase-deploys/actions/workflows/release.yml)
|
||||||
- Run release selfhost job
|
|
||||||
|
|
||||||
### Deploy Changes to Production (Hotfix)
|
|
||||||
|
|
||||||
- Branch off `master`
|
|
||||||
- Perform your hotfix
|
|
||||||
- Merge back into `master`
|
|
||||||
- Wait for budibase CI job and release job to run
|
|
||||||
- Run cloud deploy job
|
|
||||||
- Run release selfhost job
|
|
||||||
|
|
||||||
### Rollback A Bad Cloud Deployment
|
### Rollback A Bad Cloud Deployment
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1 +1 @@
|
||||||
Subproject commit 0fa909b15222b22882d6667b92c422d1057c9472
|
Subproject commit 78ba8697c4156ae10cfba9dc563ddd486ab2f6fe
|
||||||
Loading…
Reference in New Issue