You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 5 Next »

How to perform a release of the Log4j Kotlin API.

Step-by-step guide

Prerequisite Steps

  1. Run mvn clean verify on the project to make sure it builds cleanly.
  2. Make sure you have an up to date PGP key (at least 4096-bit RSA or stronger) in the Logging KEYS file along with having it mirrored in a common public PGP key repository such as Ubuntu Keyservers.
  3. Configure your git config user.signingkey, user.name, and user.email values to match that key.
  4. Ensure you have your credentials set up in ~/.m2/settings.xml as described in Log4j 2 Release Process.
    1. TODO: insert information about using encrypted passwords.

Release Steps

  1. Edit pom.xml and change the Log4jKotlinVersion property to the new version.
  2. Update the Log4jReleaseManager and Log4jReleaseKey properties if necessary.
  3. Run mvn site && mvn site:stage -DstagingDirectory=$HOME/log4j-kotlin and make sure the site looks alright.
  4. Run mvn -Papache-release -DskipTests -Darguments="DskipTests" release:prepare release:perform -DreleaseVersion=n.n.n -DdevelopmentVersion=n.n.n-SNAPSHOT -Dtag=log4j-api-kotlin-n.n.n-rcn to start the release. Enter your GPG signing key when prompted.
  5. Login to https://repository.apache.org/ with your ASF credentials. Select "Staging Repositories", then find the newly created orgapachelogging-* staging repository and close it.
  6. Checkout the release tag and run mvn site && mvn site:stage -DstagingDirectory=$HOME/log4j-kotlin to stage the site.
  7. Commit the generated site to GitHub Pages somewhere to stage it.
  8. Copy the archives and signatures from log4j-api-kotlin/target/ to https://dist.apache.org/repos/dist/dev/logging/log4j/kotlin/.
  9. Run for f in *.bz2 *.gz *.zip; do shasum -a 512 $f >$f.sha512; shasum -a 256 $f >$f.sha256; done to generate hashsums.
  10. Send a release vote email to dev@logging.apache.org with links to everything.
  11. If the release fails, drop the staging repository on repository.a.o and start over with a fresh release candidate number.
  12. Otherwise, if the release passes, complete the release on the staging repository.
  13. Run git tag -s rel/n.n.n 'log4j-api-kotlin-n.n.n-rcn^{}' -m 'Release n.n.n of Log4j Kotlin API' && git push --tags
  14. Move the distribution artifacts to https://dist.apache.org/repos/dist/release/logging/log4j/kotlin/ where a new version directory should be made.
  15. Login to https://reporter.apache.org/ to record the release.
  16. Wait 12-24 hours for mirrors to propagate.
  17. Delete the previous version in https://dist.apache.org/repos/dist/release/logging/log4j/kotlin/.
  18. See ManagingTheWebSite for committing the site to production.
  19. Update any redirect to point to new version for latest (if applicable).
  20. Send announcement email (from your apache.org email) to dev@logging.apache.org, log4j-user@logging.apache.org, and announcements@apache.org.



  • No labels