README-release.md

How to create a release

1. Update issues and pull requests so they are appropriately targeted for this milestone and closed

2. Bump the version number in README.md

   • Note: Use the standard contribution process by submitting these changes via a pull request, not a direct push to the synbiohub_adapter repository
   • Call this pull request something like "Prep 1.1 release"

3. Open a pull request to promote the release from develop to master

   • Note that the target branch may have to be manually set to master

4. Merge the promotion pull request opened in the previous step

5. Tag the release using semantic versioning

   cd <synbiohub_adapter>
   git checkout master
   git tag -a v1.X -m "Release 1.X" master
   git push upstream --tags

6. Update GitHub milestones

   • Close the current milestone
   • Create a new milestone for the next release

7. Build the wheel

   python3 setup.py sdist bdist_wheel

8. Create a GitHub release, upload the tar file and wheel

   • Create a release (Releases; Draft a new release)
   • Use the current tag
   • Name it "Major.Minor[.Patch]"
   • Add notes about what changes were made in this release. At a minimum, link to the milestone which documents the issues and pull requests that are part of the release.
   • Upload the tar file and wheel created above

9. Bump the version numbers on the develop branch

   • Note: Use the standard contribution process by submitting these changes via a pull request, not a direct push to the synbiohub_adapter repository
   • Bump version number in synbiohub_adapter/__init__.py
   • Bump version number in setup.py