Skip to content
This repository was archived by the owner on Apr 7, 2021. It is now read-only.

Release Checklist

Matthias Benkort edited this page Dec 15, 2020 · 1 revision
  • Bump all cabal versions in explorer-api, rest-common and submit-api.

  • Bump all versions in docker-compose.yml.

  • Make sure that CHANGELOG.md of explorer-api and submit-api mention the latest release.

  • Execute the automated tests for explorer-api. (see footnote #1).

  • Execute the automated tests for submit-api (see footnote #2).

  • Tag and sign a commit, with a commit message header as release {Major}.{Minor}.{Patch} and, with the changelogs for explorer-api and submit-api as commit message body.

  • Push the tag to Github and wait for the Github Actions to complete and create a release with release artifacts.

  • Write release notes following what have been done for previous releases.


(1) The automated tests will require to have a running instance of the explorer-api. There are several ways to achieve this but the easiest is to comment-out the explorer-api service in the docker-compose file and run the altered stack alongside a local instance of the explorer-api connecting to cardano-db running in a container. Another way is to simply build a local docker image of explorer-api and tag it as the latest release so that it's started with the cluster.

(2) The automated tests will require to have a running instance of the submit-api. Similarly to (1), this can be done by altering the docker-compose file locally or, by running a local instance of a cardano-node. The submit-api does not use the cardano-db or cardano-db-sync so the stack is easier to setup.

Clone this wiki locally