Release Checklist - sile-typesetter/sile GitHub Wiki

1. Make sure the Test Suite passes. :warning:

   If the current master branch is not passing any of the required remote CI tests or fails locally you should not be even starting the release steps.

   At this stage you are encouraged to use the make prerelease target at will to make sure everything runs as expected.

2. Start clean. :new:

   These steps are drastic but recommended. Don't run them if you have uncommitted work in your repository!

   git checkout master
   git fetch --all
   git reset --hard upstream/master
   

3. Fetch the tooling used for cutting releases. :wrench:

   You need this Javascript baggage to generate the ChangeLog and other stuff that will happen automatically while making the release. No you may not fake it by hand.

   npm install
   

4. Make autoconf tools happy. :boot:

   ./bootstrap.sh
   ./configure
   

5. Cut the release. :label:

   This will bump the release version, update the ChangeLog, and tag the corresponding commit.

   make release-preview
   make release
   

   The release version number will be guessed automatically based on commit messages since the last release. To override this if the preview doesn't look good add RELTYPE=patch, RELTYPE=minor, or RELTYPE=major for other version bump types.

6. Push tag. :arrow_up:

   Temporarily disable "include administrators" in master branch protection

   # Pushes both branch and tags at once
   git push upstream --tags :
   

7. Update website. :newspaper:

   • Copy PDF manual to website repository, symlink to latest, update link in menu, commit, push.
   • Copy changelog and massage the significant bits into a blog post about the release.

8. Update any distros we can. :hammer:

   • Submit Arch Linux out-of-date flag on sile package (@alerque can update).
   • Submit update to Void Linux package.
   • Submit update to Homebrew formula.
   • Submit update to NixOS package.
   • Build and push to Docker Hub make docker-build-push DOCKER_TAG=v0.11.1
   • Ping other distro managers (repology).

9. Let the world know. :loudspeaker:

   Twitter, etc.

10. Pave the way for the next release. :checkered_flag:

    • Review milestones, move any postponed issues to next release, close current release, rename next *.x milestone to next version number, add new *.x milestone for non-planned issues.

11. Eat cake. :cake:

---

See full release checklist for howto, this is just a checklist version:

---

Previous: release vX.Y.Z, checklist #NNNN.

• Shuffle any issues being put off to future milestones
• Close all issues in current milestone (except this one)
• Spring clean
  • Re-fetch tooling
• Configure and build
• Pass all tests
  • Remote CI
  • Local
• Cut release
• Push release commit & tag to master
• Download release artifacts, GPG sign, and upload signatures
• Publish release build to craties.io
• Publish rusile library to craties.io
• Update website
  • Copy and post manual, update 'latest' symlink and menu links
  • Copy changelog and prefix with a summary as a blog post
  • Tweak summary for gfm and edit into GitHub release notes
• Update downstream distro packages
  • Arch Linux: extra/sile
  • Homebrew: Formula
  • NixOS: nixpkgs
    • Drop devel flag from any website examples that were using it
  • Ubuntu: ppa
  • Docker Hub: tags
  • GHCR: versions
  • openSUSE:
  • Fedora:
  • NetBSD:
  • Void Linux:
  • OpenBSD:
• Bump downstream projects
  • FontProof (Docker image base plus CI matrix)
  • CaSILE (check, consider patch release)
• Eat cake