How to release Butterfly

Introduction

This document explains how to release a new Butterfly version.

All instructions documented here are MacOS and bash specific. Adjust them accordingly if you use a different OS and/or shell.
You must have:
1. Admin rights to Butterfly GitHub repo.
2. A Nexus Repository Manager account with access to PayPal artifacts.

Working from master branch
1. Set the new version in build.gradle
2. Run ./gradlew clean build and make sure it succeeds
3. Run ./prepare_release.sh
4. If tests/sample-apps has changed, perform the following
  1. zip tests/sample-apps/echo folder
  2. replace zip under docs/zip
  3. update link in docs/QUICK_START.md if zip file name changed
5. Add new version in docs/RELEASE_NOTES.md file
6. Commit Releasing <new version>
7. Push your changes (git push upstream master)
Go to butterfly repo in GitHub
1. Create a new release and tag from master branch
  1. New release title and tag name should be the new version
  2. Add sections New Features and enhancements and Bug fixes from release notes to Release description
  3. Create the new release and make sure the GitHub action Release Publishing is automatically triggered and succeeds
Manual sonatype release
1. Go to Nexus Repository Manager
2. Go to Staging Repositories
3. Close the butterfly staging repository
4. Release the butterfly staging repository
5. Wait a couple of hours and make sure new butterfly version shows at http://search.maven.org/#search|ga|1|g:com.paypal.butterfly
Working from master branch
1. Set the new SNAPSHOT version in build.gradle
2. Run ./gradlew clean build and make sure it succeeds
3. Commit Preparing for version <next new version>
4. Push your changes (git push upstream master)