Fissa

Run the unit test suite, with either
sh
py.test

or
sh
python setup.py test

and make sure all the unit tests pass locally.


6. Build distribution

Follow the instructions as per the [PyPI tutorial](https://packaging.python.org/tutorials/packaging-projects/) to build your distribution.
sh
rm -f .CHANGELOG.md
rm -rf dist
python -m pip install --upgrade setuptools wheel twine
python setup.py sdist bdist_wheel --universal


7. Test the submission

Checkout and update your local copy of the release branch, `vM.N.x`.
sh
git fetch
git checkout "v$MNx"
git pull


Then use `git status` to make sure you don't have any unstaged changes.
We need to run the tests on a clean copy of the branch.

If you are creating a new patch release, initiate a pull request to merge `rel_M.N.P` into the stable branch for this minor release, named `vM.N.x`,
<https://github.com/rochefort-lab/fissa/compare/vM.N.x...rel_M.N.P?expand=1>.
sh
sensible-browser "https://github.com/rochefort-lab/fissa/compare/v${MNx}...rel_${MNP}?expand=1&title=REL:%20Release%20version%20${MNP}"

You can use the contents of the CHANGELOG update as the basis of the body of your PR, but you will need to convert it from RST to markdown format first.
sh
pandoc --from rst --to markdown+hard_line_breaks CHANGELOG.rst | sed '/^:::/d' > .CHANGELOG.md


Unless the release was pre-approved, you'll need to wait for another maintainer to review the release candidate before you can merge it into the stable release branch.
Don't delete the release-candidate branch when the PR is closed, as we'll make use of it again in a later step.


5. Confirm tests pass

After the release-candidate branch has been merged into the release branch, you must release the new branch.
First, double-check the test suite runs successfully.
The test suite should also have been run on the continuous integration server during development.
This step is included to double-check what you are about to submit is a viable copy of the code.

If you are releasing a new major or minor version, you may first have to instantiate a new stable branch, which will be the target of the PR.

Browse the the list of [branches](https://github.com/rochefort-lab/fissa/branches) for the repository, and ensure that a branch bearing the name corresponding to `vM.N.x` exists.
If not, create a new branch for it based on the last stable release and push it to github.

Check the rendering of the CHANGELOG on GitHub at
<https://github.com/rochefort-lab/fissa/blob/rel_M.N.P/CHANGELOG.rst>,
where `rel_M.N.P` is replaced with your release candidate branch.

sh
sensible-browser https://github.com/rochefort-lab/fissa/blob/rel_$MNP/CHANGELOG.rst


4. Make a Pull Request

You'll need to make a PR to merge the new release into a target stable branch.

Push your changes with
sh
git push -u origin "rel_$MNP"

(where `rel_M.N.P` is replaced with your release candidate branch) to establish tracking with the remote branch.