Skip to content

Latest commit

 

History

History
36 lines (35 loc) · 1.09 KB

RELEASING.md

File metadata and controls

36 lines (35 loc) · 1.09 KB
  1. Consider whether this release will affect any customers, including those on EMS, and warn them beforehand - in case they need to upgrade quickly.

  2. Update the version number in pyproject.toml.

  3. Set a variable to the version number for convenience:

    ver=x.y.z
  4. Update the changelog:

    towncrier --version=$ver
  5. Push your changes:

    git add -u && git commit -m $ver && git push
  6. Sanity-check the changelog and update if need be.

  7. Create a signed tag for the relese:

    git tag -s v$ver

    Base the tag message on the changelog.

  8. Push the tag:

    git push origin tag v$ver

    Pushing a tag on GitHub will automatically trigger a build in Docker Hub and the resulting image will be published using the same tag as git.

  9. Create release on GH project page:

    xdg-open https://github.com/matrix-org/sygnal/releases/edit/v$ver
  10. Notify #sygnal:matrix.org, #synapse-dev:matrix.org and EMS that a new release has been published.