Skip to content

Latest commit

 

History

History
118 lines (69 loc) · 3.29 KB

release-procedure.md

File metadata and controls

118 lines (69 loc) · 3.29 KB
Raw

Release Procedure

This document explains the release procedure. It is only relevant for maintainers.

1. Install/update automation tool

We have a CLI tool to automate parts of the release process. Make sure you have the latest version of that installed.

In the Fornjot repository, run:

cargo install --path tools/automator

2. Write release announcement

The release announcement lives on the website, and needs to be created in the website repository.

First, create the initial draft of the release announcement:

automator blog release

This will create an announcement that will initially not be published to the blog or RSS feed, but it will be available at its final URL.

Now, edit this file to finish the release announcement:

  1. Curate pull requests
    • A list of pull requests has been added to the draft automatically.
    • Update and merge entries as appropriate, sort them into the categories.
  2. Write introduction
    • Summarize changes since last release.
    • Highlight contributions.
  3. Choose subtitle.

When done, deploy to the website.

3. Create release branch

In the main Fornjot repository, do this:

git switch -c release

4. Update changelog

Add a changelog entry for the new version. Copy the summary of pull requests from the release announcements and add it to the changelog.

Commit these changes: git commit -m "Update changelog"

5. Update version

Update all version keys in the top-level Cargo.toml.

Commit these changes: git commit -m "Update version"

6. Publish the release

Push the release branch:

git push -u origin release

Create a pull request:

  • Mention the version in the title (e.g. Release v0.1.2).
  • Label it as release.
  • Lock the pull request.

The pull request needs to be locked, as anything that updates it (like comments), could confuse the automation for the next release (because GitHub doesn't allow sorting pull requests by merge date, unfortunately).

Once the CI build completed successfully, merge the pull request. The release automation will now create a release on GitHub, and publish to crates.io.

7. Update release on GitHub

The GitHub Release has been created by automation in the previous step. Copy the Markdown source from the release announcement into the GitHub release. Update as necessary.

Add note up top, linking to the release announcement on the website.

8. Finish publishing release announcement

To publish the release on the website properly, add a date key to the front matter. Now the announcement should show up on the blog page and the Atom/RSS feed.

Deploy the announcement to the website.

9. Promote release announcement

Post the release announcement in the official Fornjot community channels:

  • Mailing list
  • Matrix channel

Additionally, post it in the following places:

10. Improve release procedure

You are done. Figure out what didn't go optimally, and update this release procedure accordingly.