RELEASING.md

Releasing

Set up GitHub CLI

Install GitHub CLI

brew install gh

Creating the release

• Update the changelog

mate CHANGELOG.md

• Create a local release branch from main and update VERSION_NAME in gradle.properties (removing -SNAPSHOT) and the README, then run the publish workflow and finish the release:

echo "Gradle properties: $(grep VERSION_NAME gradle.properties)" && \
printf "Enter new version (e.g., 1.2.3): " && read NEW_VERSION && \
printf "Enter next version, without '-SNAPSHOT' (e.g., 1.2.4): " && read NEXT_VERSION && \
git checkout main && \
git pull && \
git checkout -b release_$NEW_VERSION && \
sed -i '' 's/VERSION_NAME=.*-SNAPSHOT/VERSION_NAME='"$NEW_VERSION"'/' gradle.properties
sed -i '' "s/com.squareup.papa:papa:.*'/com.squareup.papa:papa:$NEW_VERSION'/" README.md && \
git commit -am "Prepare $NEW_VERSION release" && \
git tag v$NEW_VERSION && \
git push origin v$NEW_VERSION && \
gh workflow run publish-release.yml --ref v$NEW_VERSION && \
sleep 5 &&\
gh run list --workflow=publish-release.yml --branch v$NEW_VERSION --json databaseId --jq ".[].databaseId" | xargs -I{} gh run watch {} --exit-status && \
git checkout main && \
git pull && \
git merge --no-ff --no-edit release_$NEW_VERSION && \
sed -i '' 's/VERSION_NAME='"$NEW_VERSION"'/VERSION_NAME='"$NEXT_VERSION"'-SNAPSHOT/' gradle.properties && \
git commit -am "Prepare for next development iteration" && \
git push && \
gh release create v$NEW_VERSION --title v$NEW_VERSION --notes 'See [Change Log](https://github.com/square/papa/blob/main/CHANGELOG.md)'

• 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.