Skip to content

RELEASE.md

Latest commit

 

History

History
37 lines (24 loc) · 3.47 KB

RELEASE.md

File metadata and controls

37 lines (24 loc) · 3.47 KB
Raw

Releasing circles-api

Use this checklist to create a new release of circles-api and distribute the Docker image to our private DigitalOcean registry and DockerHub. All steps are intended to be run from the root directory of the repository.

Creating a new release

  1. Make sure you are currently on the main branch, otherwise run git checkout main.
  2. git pull to make sure you haven’t missed any last-minute commits. After this point, nothing else is making it into this version.
  3. npm test to ensure that all tests pass locally.
  4. git push and verify all tests pass on all CI services.
  5. Read the git history since the last release, for example via git --no-pager log --oneline --no-decorate v1.3.12^..origin/main (replace v1.3.12 with the last published version).
  6. Condense the list of changes into something user-readable and write it into the CHANGELOG.md file with the release date and version, following the specification here on how to write a changelog. Make sure you add references to the regarding PRs and issues.
  7. Commit the CHANGELOG.md changes you've just made.
  8. Create a git and npm tag based on semantic versioning using npm version [major | minor | patch].
  9. git push origin main --tags to push the tag to GitHub.
  10. git push origin main to push the automatic package.json change after creating the tag.
  11. Create a new release on GitHub, select the tag you've just pushed under "Tag version" and use the same for the "Release title". For "Describe this release" copy the same information you've entered in CHANGELOG.md for this release. See examples here.

Building and uploading Docker image to registry

All tagged GitHub commits should be uploaded to our private DigitalOcean registry and the public DockerHub registry automatically by the tagbuild.yaml GitHub Action.

After the action was completed successfully you can now use the uploaded Docker image to deploy it.

Deploy release

circles-docker

For local development we use the circles-docker repository. To use the new version of circles-api please update the following configuration here and commit the update to the circles-docker repository.

Rebuild your environment via make build to use the updated version in your local development setup. Consult the README.md in the repository to read more about this.

circles-iac

The official staging and production servers of Circles are maintained via the circles-iac repository. Both environments have separate version configurations. You will need to change the version for staging and production in the regarding imageTag fields. Commit the change to the circles-iac repository.

Deploy the release via helm to the regarding Kubernetes cluster on DigitalOcean. Consult the README.md in the repository to read more about how deploy on Kubernetes.