Skip to content

RELEASES.md

Latest commit

 

History

History
58 lines (43 loc) · 2.2 KB

RELEASES.md

File metadata and controls

58 lines (43 loc) · 2.2 KB
Raw

Matterhorn Release Process

This is the release procedure for making a release of matterhorn. Before beginning, the person making the release should have access to the platforms on which binary distributions will be built.

  1. Set the matterhorn package version. The version string must be of the form ABBCC.X.Y where ABBCC corresponds to the Mattermost server version supported by the release. For example, if the release supports Mattermost server version 1.2.3, the ABBCC portion of the matterhorn version should be 10203. The X.Y portion of the version corresponds to our own version namespace for the package. If the server version changes, X.Y SHOULD be 0.0. Otherwise the first component should increment if the package undergoes major code changes or functionality changes. The second component alone should change only if the package undergoes security fixes or other bug fixes.

  2. Generate a changelog entry list from the git log since the last release tag. In the changelog, include

    • changes to supported server versions
    • bugs fixed
    • contributions received (and thank contributors)
    • UI changes
    • new configuration options and keybindings
    • server feature support changes

    The changes listed in the changelog should inform the choice of version number.

  3. Commit the changelog changes and matterhorn.cabal version change.

  4. Check for a passing Travis CI build.

  5. Upload to Hackage:

    • Generate a cabal sdist
    • Unpack the sdist archive
    • Perform a complete build on the unpacked archive
    • If any issues arise, repair and go to (2)
    • Otherwise, cabal upload the package

  6. Generate platform binary distributions using mkrelease.sh on the relevant platforms.

  7. Tag the release commit using the package version as the tag string.

  8. git push --tags

  9. Make binary release available on GitHub by editing the pushed tag and uploading the release archives.

  10. Tweet about the release using the @matterhorn_chat account: "We're pleased to announce the release of Matterhorn version for @mattermosthq! Get it at https://github.com/matterhorn-chat/matterhorn/releases/tag/"