Skip to content

Latest commit

 

History

History
27 lines (22 loc) · 3.18 KB

releasing.md

File metadata and controls

27 lines (22 loc) · 3.18 KB

Releasing Orion

When releasing new version of Orion make sure that:

  1. All pull requests you wish to include in the release are already merged into the master branch.
  2. Orion version has been bumped and the CHANGELOG file has been updated according to instructions provided in Versioning.
  3. The CHANGELOG clearly states all changes included in the release that:
    • could break or in some other way significantly affect the behavior of previous versions of Atlas (ie. are affecting the GraphQL API / Auth API),
    • require additional steps to be taken by the Gateway operators that wish to upgrade to the new version. For example:
      • introduction of new environment variables or changes to existing environment variables,
      • changes to database schema that would require the operators to execute non-standard migration steps,
      • changes to default docker-compose configuration that would require the Operators make adjustments to their current setup.
  4. All other documentation has been properly updated to reflect any significant changes introduced in the release. This includes both this documentation (the Orion Developer Guide) and the Orion Operator Guide.
  5. In case of any changes related to environment variables or docker configuration, make sure a PR to update Orion docker setup in the Joystream monorepo has been created and merged as well (example: Joystream/joystream#4730)
  6. In case any changes are affecting Offchain data schema in a non-backward-compatible way, make sure a proper export data migration step was added accordingly to Introducing breaking changes to Offchain data schema.

Once all of those conditions are met, you can proceed with creating a GitHub release:

  1. Create a new tag matching the version specified in package.json (for example: 2.3.0) on the release commit.
  2. Use the same version number as the release title as well.
  3. When describing the release:
    • Add a note about whether the upgrade of Atlas is also required/recommended for the Gateway operators. If it is, make sure to specify the version of Atlas compatible with the new Orion version.
    • Make sure to describe any non-standard upgrading requirements / steps. By non-standard we mean any steps that are a deviation from Typical upgrade process described in Upgrading Orion tutorial inside the Orion Operator Guide.
    • Provide a link to the related CHANGELOG entry.

Updating Orion for Gleev

When updating Orion instance used by the Gleev gateway, you should generally follow Upgrading Orion tutorial from the Orion Operator Guide. If you notice that any deviations from the standard upgrade process are required, make sure they are mentioned in the release notes as described above.