Skip to content

RELEASE.md

Latest commit

 

History

History
62 lines (42 loc) · 2.82 KB

RELEASE.md

File metadata and controls

62 lines (42 loc) · 2.82 KB

Releasing Protocol Designer

This document describes the release process for Protocol Designer.

Philosophy

Releases are intended to run from the Github Actions workflow: .github/workflows/pd-test-build-deploy.yaml. All process and configuration for release is contained in scripts/static-release. With the correct AWS credential and profile, the script to release may be run locally for testing, debugging, or in an emergency for actual release if GitHub Actions is down.

Tags

Tags should be annotated and pushed one at a time. Please do not push all your tags at once with git push --tags. Push the individual tag like so:

git tag -a protocol-designer@8.6.0 -m "production release for 8.6.0"
git push origin protocol-designer@8.6.0

Environments

sandbox: https://sandbox.designer.opentrons.com/{branch} staging: https://staging.designer.opentrons.com/ production: https://designer.opentrons.com/

Sandbox

Every branch with an open PR gets deployed to sandbox. edge and chore_release* branches also deploy to sandbox on any push.

Staging

To deploy a build to staging, create an annotated tag with the prefix staging-protocol-designer and push it to GitHub. The tag name should be of the form staging-protocol-designer@X.Y.Z-alpha.N where X.Y.Z is a semver version number matching the release cycle and N is incremented with each alpha build.

git tag -a staging-protocol-designer@8.6.0-alpha.1 -m "staging build for 8.6.0"
git push origin staging-protocol-designer@8.6.0-alpha.1

Production

To deploy a build to production, create an annotated tag with the prefix protocol-designer and push it to GitHub. The tag name should be of the form protocol-designer@X.Y.Z where X.Y.Z is a semver version number matching the release cycle. This tag goes on the same commit as the staging tag for the final alpha build of the release cycle.

git tag -a protocol-designer@8.6.0 -m "production release for 8.6.0"
git push origin protocol-designer@8.6.0

Rollback

To "roll back" a release, we push a new tag on the previously working commit. The semver will roll forward always, but the code will be identical to the previous release. We do not delete tags or releases in GitHub for "rollback" releases. For example, if the current production release is protocol-designer@8.6.0 and we want to roll back to protocol-designer@8.5.0, we would do the following:

#find the commit sha of the 8.5.0 release
git switch chore_release-pd-8.5.0
git log --oneline -n 20
git checkout <commit-sha-of-tag-protocol-designer@8.5.0>
git tag -a protocol-designer@8.5.1 -m "rollback to 8.5.0"
git push origin protocol-designer@8.5.1

This would create a new production release protocol-designer@8.5.1 that is identical to protocol-designer@8.5.0.