Skip to content

Latest commit

 

History

History
67 lines (45 loc) · 3.22 KB

RELEASE.md

File metadata and controls

67 lines (45 loc) · 3.22 KB
Raw

Release Process

Steps

This is a summary of the steps to get a change into production.

  1. Merge SQS PR into main (currently v25.x) once approved
  2. Create an RC tag e.g. v0.20.0-rc0 and push it to the repo. See below for version number semantics.
  3. Create infrastructure PR for updating SQS configuration files and deployment version specifications.
    • config.json.j2 (optional, as needed)
    • sqs.yaml (optional, as needed)
    • versions.yaml (required) IMPORTANT: Remember to omit the v from the tag name, e.g. tag name v25.1.0, use 25.1.0 in versions.yaml
  4. Get infrastructure PR approved and merged into main
  5. Manually perform stage deployment via Rundeck
  6. Test & request QA
  7. Update changelog and reference the Docker tag for the chain that is compatible with the release.
  8. Tag the non-RC release e.g. v0.20.0 and push it to the repo.
  9. (production deployment only) Run e2e test by make e2e-run-dev to do a final check. API key must be specified thru environment variable SQS_API_KEY before running the test.
  10. (production deployment only) Repeat step 3 and 4.
  11. Manually perform prod deployment via Rundeck
  • Post updates in #eng-deployment-announcements
  • Deployment start
  • Issues/blockers, if any
  • Deployment end

Tagging RC

The rc numbers should be incremented for any changes that occur in staging and before getting to production.

Example:

Let's say that we plan a release, and the current version is v0.18.5. Then, we tag a v0.18.6-rc0 and push it to the stage for testing. QA uncovers a bug during stage testing. We push a fix, incrementing the rc number for a new stage tag - v0.18.6-rc1. Now, the stage QA passes, and we proceed to production with v0.18.6.

Versioning

We follow semantic versioning.

For compatibility with the chain releases, we will increment the major version for any chain upgrade.

For any API, config breaking changes or new features, we aim to increment a minor version to reflect the breaking change.

For any minor bug fixes, non-breaking changes and small improvements, we increment the patch version.

Note that we will are tagging rc rather than the final tags for work that is still not ready for production and is being tested.

Oftentimes, versions within the same major (e.g. v25.x) release line for node are incompatible with versions within v25.x release line of SQS.

We leave the compatibility pairs in the CHANGELOG.

Additionally, we aim to keep the tip of osmosis major release branch in sync with the tip of sqs major release branch.

So, two cases for using the versioning:

  1. Compatibility versions from the changelog
  2. The latest commit tag of the major release branch of osmosis and the latest commit tag of the major release branch of sqs.

Configuration

General

The suggested configuration can be found:

  • config.json for mainnet configuration.
  • config-testnet.json for testnet configuration

Internal

For Osmosis internal use, please always refer to the relevant environment in the infrastructure repository.