Issuing gsapyΒΆ

Note, this page is out of date and will be updated soon!

This page outlines the steps required to push a new issue of gsapy

Pre-issue steps:

  1. Make sure the code is ready to issue.

  2. Make sure the tests run.

  3. Update the documentation

    • Whenever you refer to the current gsapy version in the text, write |version|. The release script will replace it with the current version when the documentation is rebuilt.

    • If you want to refer to a particular (constant) version of gsapy, just write the version number.

  4. Add a changelog fragment (docs/changelog/{version}.md.include) that describes the change (this should as the work progresses)

To prepare the issue:

  1. Merge all changes to the master branch.

  2. Add a tag to the release commit in the format vMAJOR.MINOR.PATCH.

  3. Create a branch called release/vX.Y.Z that points to the release commit

  4. Merge the latest branch to the release commit

  5. Write an announcement on the gsapy Yammer group!!