Skip to content

RELEASING.md

Latest commit

 

History

History
43 lines (34 loc) · 1.59 KB

RELEASING.md

File metadata and controls

43 lines (34 loc) · 1.59 KB
Raw

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:
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.logcat:logcat:.*'/com.squareup.logcat:logcat:{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/logcat/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.