Page History

Before beginning your first release, take the following preparatory steps:

Make sure you have Java 8 as the default JDK.
Run mvn clean install on Run mvn clean install on the project to make sure it will build cleanly.
Run mvn -P rat -DskipTests clean verify to verify all the licenses are valid.
Login to httphttps://repository.apache.org using your ASF credentials. Click on your username in the upper-right-hand corner and click Profile. Make sure your email address is correct. If not, contact Infra to get it corrected. You will be unable to get the necessary notifications until it's corrected.
Make sure you have a 4096-bit RSA PGP key pair for code signing. The public key should be published in a public repository, preferably http://pgpkeyserver.mitubuntu.edu/com. Also make sure the public key is published to httphttps://www.apache.org/dist/logging/KEYS.
Configure this key as your git signing key for release tags: git config user.signingkey 0x1234567812345678
1. Make sure your user.name and user.email git config values match the name and email of this GPG key.
Edit ~Edit ~/.m2/settings.xml to xml to add the corresponding private key and its passphrase to your settings. Also add the Apache Subversion server credentials and Sonatype repository credentials to your settings (this is your ASF credentials). You'll want to blank out the passphrase after each release and fill it back in prior to each release so that it isn't compromised. Alternatively, you can encrypt your passwords with a master password.

Code Block

    <profiles>
        <profile>
            <id>apache-release</id>
            <properties>
                <gpg.keyname>ABC123FC</gpg.keyname>
                <gpg.passphrase>thisIsMyPassphrase</gpg.passphrase>
                <gpg.executable>gpg2</gpg.executable><!-- Use this if executable differs from "gpg" -->
            </properties>
        </profile>
    </profiles>

    <activeProfiles>
        <activeProfile>apache-release</activeProfile>
    </activeProfiles>

    ...

    <servers>
        <server>
            <id>svn.apache.org</id>
            <username>myUsername</username>
            <password>myPassword</password>
        </server>
        <server>
            <id>apache.releases.https</id>
            <username>myUsername</username>
            <password>myPassword</password>
        </server>
        <server>
            <id>apache.snapshots.https</id>
            <username>myUsername</username>
            <password>myPassword</password>
        </server>
    </servers>

Once you've done this, take the following steps to perform a release:

Edit pomEdit pom.xml and change the Log4jReleaseVersion property xml and change the Log4jReleaseVersion property to the version you are releasing.
Make a fresh Git clone of the master branch of https://git-wip-us.apache.org/repos/asf/github.com/apache/logging-log4j2.git. Update src
Update src/changes/announcement.vm
Run mvn -P release-notes generate-resources to create the release notes.
Update src/changes/changes.xml with the release date.
Pick a logo from src/site/resources/logos. Edit it with Gimp to add the release version number and save it as a png. Copy the saved logo to src/site/resources/images/logo.png.
changelog/.changelog.adoc.ftl with the appropriate release text.
Ensure that log4jReleaseVersion property is set in the root pom.xml to the release number to be created
Run
Code Block
mvn -P changelog-release validate
to generate the changelog for the release. After running delete directory src/changelog/2.x.x. (This will need to be recreated later).
Run
Code Block
mvn clean site
to build the web site.
Copy target/site/release-notes/${log4jReleaseVersion}.html into https://codebeautify.org/html-to-markdown or a similar site and then edit the generated Markdown as appropriate, ensuring the appropriate license header is included and the headings are correct.
Save the edited text to RELEASE-NOTES.md.
Run git add, git commit, and git push to commit the RELEASE-NOTES.md file Run git add, git commit, and git push to commit the RELEASE-NOTES.txt file that was just generated along with the other files that were modified.
Copy the site: Run mvn site followed by mvn site:stage
Code Block
mvn site:stage -DstagingDirectory=$HOME/log4j
where $HOME is log4j where $HOME is your home directory and verify that the site looks good. Repeat steps 6-10 as necessary.

Run mvn

Code Block
mvn -P apache-release -DskipTests -Darguments="-DskipTests" release:prepare release:perform -DreleaseVersion=n.n.n -DdevelopmentVersion=n.n.n-SNAPSHOT -Dtag=log4j-n.n.n-rcn

rcn to start the release. Enter the password to your signing key when prompted.

Login to http://repository.apache.org using your ASF credentials. Select "Staging Repositories" then check the org.apache.logging repository and close it.
Check out the release tag that was created via the Maven release plugin using git checkout tagsusing git checkout tags/tagname.
Run mvn site in Run mvn site in the tag directory. When that completes run mvn siterun mvn site:stage -DstagingDirectory=$HOME/log4j where $HOME is log4j where $HOME is your home directory.
Zip the contents of $HOME/log4j with zip of $HOME/log4j with zip -r log4j.zip log4j. Commit
Create the site to your github.io account. Copy the distribution archive files from log4j-distribution/target to where preview web site:
1. Clone the Log4j web site from https://
dist
1. github.com/apache
.org/repos
1. /
dist/dev/
1. logging
/log4j/ is checked out on your machine.
1. Generate the md5 checksum of the bin and source archive files using md5 apache-log4j-2.x-site.zip > apache-log4j-2.x-xxx.zip.md5, md5sum apache-log4j-2.x-xxx.zip > apache-log4j-2.x-xxx.zip.md4, or gpg --print-md MD5 apache-log4j-2.x-xxx.zip > apache-log4j-2.x-xxx.zip.md5.
2. Generate the sha1 checksum of the bin and source archive files using sha apache-log4j-2.x-site.zip > apache-log4j-2.x-xxx.zip.sha1, shasum apache-log4j-2.x-xxx.zip > apache-log4j-2.x-xxx.zip.sha1, or gpg --print-md SHA1 apache-log4j-2.x-xxx.zip > apache-log4j-2.x-xxx.zip.sha1.
3. git. Checkout the asf-staging branch.
4. Create a directory matching the target release version. Unzip the site zip file into that directory. Unlink the 2.x symlink and link it to the newly created directory.
5. Commit and push the web site preview.
Copy the distribution archive files from log4j-distribution/target Add the site zip to where https://dist.apache.org/repos/dist/dev/logging/log4j/ is checked out on your machine.
1. Sign the site ZIP file using gpg --armor --output apache-log4j-2.x-site.zip.asc --detach-sig apache-log4j-2.x-site.zip. You can use the --local-user [key ID] option (it must come before --detach-sig) to specify the exact key to use when signing the ZIP file.
2. Generate the md5 checksum of the site ZIP using md5 apache-log4j-2.x-site.zip > apache-log4j-2.x-site.zip.md5, md5sum apache-log4j-2.x-site.zip > apache-log4j-2.x-site.zip.md4, or gpg --print-md MD5 apache-log4j-2.x-site.zip > apache-log4j-2.x-site.zip.md5.
3. Generate the sha1 checksum of the site zip using sha apache-log4j-2.x-site.zip > apache-log4j-2.x-site.zip.sha1, shasum apache-log4j-2.x-site.zip > apache-log4j-2.x-site.zip.sha1, or gpg --print-md SHA1 apache-log4j-2.x-site.zip > apache-log4j-2.x-site.zip.sha1.
Generate the release vote email:
1. Create the email addressed to dev@logging.apache.org. Sending the email to the PMC is not necessary.
2. Copy the changes in the release from RELEASEfrom RELEASE-NOTES.txt into txt into the email.
3. Provide a link to the tag, web site on http://people.apache.org, and the artifacts in the Nexus repository.
4. Provide the command to download all the artifacts: wget
  Code Block
  wget -e robots=off --cut-dirs=
  3
  7 -nH -r -p -np --no-check-
  certificate $LINK where $LINK is
  certificate $LINK
  where $LINK is the URL to the repository you just closed (plus
  the org
  the org/apache/logging/log4j/ path appended).
If the release vote fails proceed as described in the section below, otherwise if it passes:
1. Create a new (immutable) tag named log4j- rel/n.n from the log4j-n.n.n-rcn rcn tag by changing to the changing to the directory containing the source for the release and performing git tag -a log4j-n.n performing
  Code Block
  git tag [--local-user userId] -s rel/n.n.n -m "Release n.
  n of Log4j"}} followed by {{{
  n.n of Log4j"
  where --local-user is optional, followed by
  Code Block
  git push --tags

The following steps must be performed by a PMC member:

Checkout https://dist.apache.org/repos/dist/release/logging/log4j.
Create the release directory under the log4j directory.
Move all the distribution artifacts from the distribution dev location to that directory.
Perform an svn add of the release directory.

Example:

Code Block

# create directory for release
svn mkdir https://dist.apache.org/repos/dist/release/logging/log4j/n.n.n
svn commit
# move files from dev to release (fully server-side; no more uploads!); this action is its own commit
svn mv $(svn ls '^/dev/logging/log4j' | grep apache-log4j-n.n.n | xargs printf '^/dev/logging/log4j/%s ') '^/release/logging/log4j/n.n.n'
# remove previous release
svn rm https://dist.apache.org/repos/dist/release/logging/log4j/n.n.n-1
svn commit

Commit the release to Subversion.

Login to reporter.apache.org and add the release version and date.
Login to Jira and mark the version as released today.

The following steps can then be taken by whomever started the release:
1. Delete the core-its project from the Nexus repository.
2. Release the remaining artifacts in the Nexus Repository.
3. Add directory 2.x.x to src/changelog.
Wait 12-24 hours (or after the distribution artifacts have been propagated to the mirrors and the Maven artifacts have been propagated to the Central Repository), and then the following steps must be performed by a PMC member:
1. Perform svn delete on Perform svn delete on the previous release directory for the same version under the log4j directory (https://dist.apache.org/repos/dist/release/logging/log4j).
2. Commit the delete to Subversion.
3. See ManagingTheWebSite regarding sub-projects.
  Copy the release
4. In your log4j web site
  from the local directory where it was deployed into the sub-project directory and make it be the current link.
  repo checkout the asf-site branch. Perform git checkout asf-site then git rebase asf-staging and finally git push. Wait 5 to 10 minutes and verify the web site is live.
After the website is updated, send the release announcement email. This should be sent out to dev@logging.apache.org, and log4j-user@logging.apache.org, private@logging.apache.org, and general@logging.apache.org.
Send the release announcement to announcements@apacheannounce@apache.org using your apache.org email address. This can be combined with the previous step as a Cc field as long as the To field is the dev@ list and you send the email from your ASF email.

If the release fails before sending the vote email:

Login to httphttps://repository.apache.org using your ASF credentials. Select "Staging Repositories" then check the org.apache.logging repository and drop it.
Revert any changes that have not been committed.
Restart the release process as the same release candidate.

If the release fails after sending the vote email:

Login to httphttps://repository.apache.org using your ASF credentials. Select "Staging Repositories" then check the org.apache.logging repository and drop it.
Rename the release tag in Git to add rcn to add rcn to the end of the tag. Note that this may not be possible in Git depending on configuration
Restart the release process as a new release candidate.

Space shortcuts

Page tree

Versions Compared

Old Version 7

New Version Current

Key