Skip to content
🤔 Documentation issue? Report or edit

Releasing LeakCanary

Preparing the release environment

Set up your Sonatype OSSRH account

  • Create a Sonatype OSSRH JIRA account.
  • Create a ticket to request access to the com.squareup.leakcanary project. Here’s an example: OSSRH-54959.
  • Then ask someone with deployer role from the LeakCanary team to confirm access.

Set up your signing key

# Create a new key
gpg --gen-key
# List local keys. Key id is last 8 characters
gpg -K
cd ~/.gnupg
# Export key locally
gpg --export-secret-keys -o secring.gpg
# Upload key to Ubuntu servers
gpg --send-keys --keyserver <KEY ID>
# Confirm the key can now be found
gpg --recv-keys --keyserver <KEY ID>

Set up your home

Add this to your ~/.gradle/

signing.keyId=<KEY ID>
signing.password=<KEY PASSWORD>

Set up the Google Analytics docs key

Add this to your ~/.bashrc:


Set up GitHub CLI

Install GitHub CLI

brew install gh

Install jq, a CLI Json processor

brew install jq

Set up aliases for milestone management:

gh alias set listOpenMilestones "api graphql -F owner=':owner' -F name=':repo' -f query='
    query ListOpenMilestones(\$name: String\!, \$owner: String\!) {
        repository(owner: \$owner, name: \$name) {
            milestones(first: 100, states: OPEN) {
                nodes {

gh alias set --shell createMilestone "gh api --method POST repos/:owner/:repo/milestones --input - | jq '{ html_url: .html_url, state: .state, created_at: .created_at }'"

gh alias set --shell closeMilestone "echo '{\"state\": \"closed\"}' | gh api --method PATCH repos/:owner/:repo/milestones/\$1 --input - | jq '{ html_url: .html_url, state: .state, closed_at: .closed_at }'"

Install or update the doc generation dependencies

python3 -m venv venv
source venv/bin/activate
pip3 install --requirement docs/requirements.txt


  • Create a local release branch from main

    git checkout main && \
    git pull && \
    git checkout -b release_3.0-alpha-9

  • Update VERSION_NAME in (remove -SNAPSHOT)

    sed -i '' 's/VERSION_NAME=3.0-alpha-9-SNAPSHOT/VERSION_NAME=3.0-alpha-9/'

  • Update the current version and next version in mkdocs.yml

    sed -i '' 's/3.0-alpha-9/NEXT/' mkdocs.yml
    sed -i '' 's/2.14/3.0-alpha-9/' mkdocs.yml

  • Create the release

    git commit -am "Prepare 3.0-alpha-9 release" && \
    ./gradlew clean && \
    ./gradlew build && \
    git tag v3.0-alpha-9 && \
    git push origin v3.0-alpha-9 && \
    ./gradlew publish --no-daemon --no-parallel && \
    ./gradlew closeAndReleaseRepository && \
    ./gradlew shark:shark-cli:distZip

Note: if anything goes wrong, you can manually drop the release at

  • Merge back to main
    git checkout main && \
    git pull && \
    git merge --no-ff release_3.0-alpha-9
  • Update VERSION_NAME in (increase version and add -SNAPSHOT)

    sed -i '' 's/VERSION_NAME=3.0-alpha-9/VERSION_NAME=NEXT-SNAPSHOT/'

  • Generate the Dokka docs

    rm -rf docs/api && ./gradlew siteDokka

  • Update the changelog (commit list)

    mate docs/

  • Deploy the docs locally then open the changelog and check everything looks good

    source venv/bin/activate && \
    mkdocs serve

  • Finish up the release

git commit -am "Prepare for next development iteration" && \
git push && \
source venv/bin/activate && \
mkdocs gh-deploy && \
gh release create v3.0-alpha-9 ./shark/shark-cli/build/distributions/ --title v3.0-alpha-9 --notes 'See [Change Log](' && \
gh listOpenMilestones | jq '.data.repository.milestones.nodes[0].number' | xargs gh closeMilestone && \
echo '{
  "state": "open",
  "description": ""
}' | gh createMilestone
  • Open the v3.0-alpha-9 release to confirm everything looks good.

  • Upload shark-cli to brew:

    brew bump-formula-pr --url leakcanary-shark

  • Wait for the release to be available on Maven Central.

  • Tell your friends, update all of your apps, and tweet the new release. As a nice extra touch, mention external contributions.