Skip to content

Latest commit

 

History

History
107 lines (82 loc) · 5.5 KB

ReleaseProcess.md

File metadata and controls

107 lines (82 loc) · 5.5 KB
Raw

#Gson Release Process

The following is a step-by-step procedure for releasing a new version of Google-Gson.

  1. Go through all open bugs and identify which will be fixed in this release. Mark all others with an appropriate release tag. Identify duplicates, and close the bugs that will never be fixed. Fix all bugs for the release, and mark them fixed.
  2. Edit pom.xml and update the versions listed for Export-Package to the target version. Also add any new Java packages that have been introduced in Gson.
  3. Ensure all changelists are code-reviewed and have +1
  4. Ensure that your ~/.m2/settings.xml is configured properly (see steps below)
  5. cd gson; ensure there are no open files and all changes are committed.
  6. Run mvn release:clean
  7. Do a dry run: mvn release:prepare -DdryRun=true
  8. Start the release: mvn release:prepare
  • Answer questions: usually the defaults are fine.
  • This will do a full build, change version from -SNAPSHOT to the released version, commit and create the tags. It will then change the version to -SNAPSHOT for the next release.

  1. Ensure you have defined sonatype-nexus-staging in your Maven settings.xml and run:

    mvn -s /home/<username>/.m2/settings.xml release:perform

  2. Log in to Nexus repository manager at Sonatype and close the staging repository for Gson. If you run into an error regarding missing signatures, you need to manually upload the artifacts using mvn gpg:sign-and-deploy-file for Gson binary, source and Javadoc jars.

cp -r ~/.m2/repository/com/google/code/gson/gson/1.7.2 /tmp
cd /tmp/1.7.2

mvn gpg:sign-and-deploy-file \
    -Durl=https://oss.sonatype.org/service/local/staging/deploy/maven2/ \
    -DrepositoryId=sonatype-nexus-staging \
    -DpomFile=gson-1.7.2.pom \
    -Dfile=gson-1.7.2-javadoc.jar \
    -Dclassifier=javadoc

mvn gpg:sign-and-deploy-file \
    -Durl=https://oss.sonatype.org/service/local/staging/deploy/maven2/ \
    -DrepositoryId=sonatype-nexus-staging \
    -DpomFile=gson-1.7.2.pom \
    -Dfile=gson-1.7.2-sources.jar \
    -Dclassifier=sources

mvn gpg:sign-and-deploy-file \
    -Durl=https://oss.sonatype.org/service/local/staging/deploy/maven2/ \
    -DrepositoryId=sonatype-nexus-staging \
    -DpomFile=gson-1.7.2.pom \
    -Dfile=gson-1.7.2.jar
  1. Close the Gson repository. Download and sanity check all downloads. Do not skip this step! Once you release the staging repository, there is no going back. It will get synced with Maven central and you will not be able to update or delete anything. Your only recourse will be to release a new version of Gson and hope that no one uses the old one.
  2. Release the staging repository for Gson. Gson will now get synced to Maven central with-in the next hour. For issues consult Sonatype Guide.
  3. Publishing Javadocs
# Switch to the branch `gh-pages`
git checkout gh-pages

# Unpack the generated Javadoc
jar xvf /tmp/2.5/gson-2.5-javadoc.jar

# Commit the new Javadoc
git commit -m 'Updated Javadoc to 2.5'

# Push changes to GitHub
git push
  1. Update the version in the Using Gson with Maven2 page
  2. Update Gson Changelog. Also, look at all bugs that were fixed and add a few lines describing what changed in the release.
  3. Create a post on the Gson Discussion Forum
  4. Update the release version in Wikipedia and update the current "stable" release.

Configuring a machine for deployment to Sonatype Repository

This section was borrowed heavily from Doclava release process.

  1. Install/Configure GPG following this guide.
  2. Create encrypted passwords.
  3. Create ~/.m2/settings.xml similar to as described in Doclava release process.
  4. Now for deploying a snapshot repository, use mvn deploy.

Getting Maven Publishing Privileges

Based on Gson group thread:

  1. Sign up for a Sonatype account following instructions under (2) on that page
  2. Ask one of the existing members of the repository to create a JIRA ticket (Step 3 of above document) to add you to the publisher list.

Running Benchmarks or Tests on Android

  • Download vogar

  • Put adb on your $PATH and run:

    vogar --benchmark --classpath gson.jar path/to/Benchmark.java

For example, here is how to run the CollectionsDeserializationBenchmark:

export ANDROID_HOME=~/apps/android-sdk-mac_x86
export PATH=$PATH:$ANDROID_HOME/platform-tools/:$ANDROID_HOME/android-sdk-mac_x86/tools/
$VOGAR_HOME/bin/vogar \
    --benchmark \
    --sourcepath ../gson/src/main/java/ \
    src/main/java/com/google/gson/metrics/CollectionsDeserializationBenchmark.java \
    -- \
    --vm "app_process -Xgc:noconcurrent,app_process"