22 Release Checklist

Paul Schaub edited this page 2024-10-14 23:15:25 +02:00

• Update CHANGELOG.md and dependency version in README.md and pgpainless-sop/README.md
• If SOP revision bump:
  • Verify that VersionImpl.SOP_VERSION is up to date.
  • Update Spec Revision number in shields.io badge
  • Run pgpainless-cli/rewriteManPages.sh to keep man pages in sync.
• If BC version bump: Check for disabled tests that are now fixed.
• Check if code is in good shape -> gradle check javadocAll
• Perform a run of the OpenPGP Interoperability Testsuite to rule out any CLI issues
• If MAJOR or MINOR version bump:
  • git checkout -b release/X.Y
  • Update SECURITY.md with supported versions
• Set the version in version.gradle. Don't forget to set isSnapshot = false
• export PGPAINLESS_VERSION=X.Y.Z
• create commit: git commit -a -S -m "PGPainless $PGPAINLESS_VERSION"
• create signed tag: git tag -s $PGPAINLESS_VERSION -m "PGPainless $PGPAINLESS_VERSION"
• clean the repository: git clean -xdf
• release to maven central: gradle publish publishToMavenLocal
• start next snapshot by bumping version in version.gradle and setting isSnapshot = true
• create snapshot commit: git commit -a -S -m "PGPainless-X.Y.(Z+1)-SNAPSHOT"
• push to the repository: git push && git push --tags
• Update topic in #pgpainless IRC channel: /topic PGPainless X.Y.Z -- Use OpenPGP Painlessly on Java -- https://pgpainless.org -- https://github.com/pgpainless -- https://codeberg.org/PGPainless -- https://pgpainless.rtfm.io