Release Process

The instructions below assume that you have commit rights on the project and have agreed with the community that a release is due.

• Test the release locally
  • Make sure your local copy of the code is up to date
  • Build and run the API locally (make docker-build-development docker-run-development)
  • Test in your browser at http://localhost:5000
• Update version in code
  • Check the version number in the file pyproject.toml matches your release
    • If not, use poetry version to update it, e.g. poetry version patch
  • Create and merge a PR with the change
• Check the dev Clever Cloud deployment
  • Synchronize the branch dev-clever with your release
    • Check out the upstream repo (i.e. boavizta/boaviztapi)
    • git checkout dev-clever && git reset --hard origin/dev-clever && git reset --hard origin/main
  • Wait for the Github Action to generate the requirements.txt file on that branch (see Github Actions)
  • Wait until it's deployed (check the version on https://dev.api.boavizta.org/docs)
  • Test the dev API
  • Test the dev DataVizta
• If everything is OK, generate a new release from the Releases page
  • Create a new tag 'vx.x.x' as part of it
  • Automatically generate the release notes
  • Check the Github Actions triggered by the release have passed
  • Check that the image is available in the container registry
• Update the main Clever Cloud deployment
  • Synchronize the branch run-clever with your tag
    • Check out the upstream repo (i.e. boavizta/boaviztapi)
    • git checkout run-clever && git reset --hard origin/run-clever && git reset --hard vx.y.z
  • Wait for the Github Action to generate the requirements.txt file on that branch (see Github Actions)
  • Wait for it to be deployed (check the version on https://api.boavizta.org/docs)
  • Test the production API
  • Test the production DataVizta
• Move to the next version
  • Create a new milestone for the next release and close the one for the release you just made

Finally tell the community that the new release is available.