Skip to content

Releasing

Jump to bottom
Robin Stocker edited this page Oct 21, 2024 · 3 revisions
  1. Prepare a PR for release:
    1. Prepare CHANGELOG, e.g. with git log --first-parent commonmark-parent-0.xx.0..
    2. If minor version should be bumped (as opposed to just patch), run mvn versions:set -DnewVersion=0.yy.0-SNAPSHOT
  2. Merge PR, wait for main to be green
  3. On GitHub, go to Actions -> "release", click "Run workflow", refresh the page, click on the new run
  4. Click "Review deployments" to start release
  5. Check to logs (and hope the release goes smoothly); see https://central.sonatype.org/faq/ for some common problems
  6. Wait for artifacts to land on Maven Central, see e.g. https://central.sonatype.com/artifact/org.commonmark/commonmark/versions
  7. README.md: Update the version numbers and any documentation
  8. Create a release from the tag, copy and pasting the release notes from CHANGELOG
  9. Go through addressed issues and add a comment mentioning that it has been released
  10. Announce the release
Clone this wiki locally