Skip to content

New release checklist (for maintainers)

Alejandro González edited this page May 10, 2026 · 10 revisions

Authorized maintainers must complete the following steps when making a new release. Horizontal lines separate blocks of tasks that must be completed entirely before the next block.

  • Ensure that the version information in every Cargo.toml file is correct. For example, when publishing v0.3.1, the version of every PackSquash package must be v0.3.1.
  • Make sure that the Debian package has the appropriate contents and metadata. Pay special attention to its version and dependencies.
  • Write the necessary wiki changes to document the changes in the new release. Don't publish them yet.
  • Thoroughly test the new release with real packs in the game.
  • Do any necessary preparations to the GitHub action and/or its binary manifests.

  • Make sure that the mainline passes every CI check and builds correctly shortly before publishing the release.
  • Push a new version tag. This will create a draft release for it, where the changelog and release notes are to be written.
  • Ensure that the push tag event CI workflow attached the artifacts it generated to the draft release.
  • When the tag CI build completes, check that the embedded version information in the executable is correct (run packsquash --version). If it is not correct, remove the tag, fix the cause ASAP, and recreate the tag.
  • Publish the draft release.
  • Publish the wiki changes. Where applicable, remember to add a link to the older version of the documentation, for the older release.


  • Announce the update on the Discord PackSquash updates channel, tagging the PackSquash updates role.
  • Announce the update on PlanetMinecraft.
  • Announce the update to other stakeholders: Nexo, interested users, etc.

  • Bump the versions in the source code to the next release.

Clone this wiki locally