Skip to content

Latest commit

 

History

History
21 lines (18 loc) · 973 Bytes

RELEASE_CHECKLIST.md

File metadata and controls

21 lines (18 loc) · 973 Bytes
Raw

Release checklist

In order to release a new version to Hex.pm we first need to:

  1. Write the changes in the CHANGELOG.md file
  2. Create a release branch named release/<version>
  3. Update the README.md, CHANGELOG.md, mix.exs, and Cargo.toml with the new version
  4. Commit with message Release <version>
  5. Merge PR to main
  6. Tag main with git tag <version>
  7. Push tag with git push origin <version>
  8. Wait for the CI to build all release files
  9. Run mix rustler_precompiled.download MeeseeksHtml5ever.Native --all --print
  10. Copy the output of the mix task and add to the release notes
  11. Run MIX_ENV=docs mix docs
  12. Run MIX_ENV=docs mix hex.publish and make sure the checksum file is present in the list of files to be published.

It's important to ensure that we publish the checksum file with the package because otherwise the users won't be able to use the lib with precompiled files. They will need to always enforce compilation.