Skip to content

Commit

Permalink
Merge pull request #154 from zakv/update-release-instructions
Browse files Browse the repository at this point in the history
Mention stashing changes in release instructions
  • Loading branch information
zakv authored Aug 12, 2022
2 parents 157b8ca + 8b54e1e commit cb3a59d
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion RELEASE_INSTRUCTIONS.rst
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,8 @@ This document describes the process for generating new M-LOOP releases and is in
* ``pip install -e .`` (Make sure to cd to M-LOOP project root directory first.)

#. Ensure you've checked out the master branch in your local repo and pulled the most recent changes, including the PR to bump the version numbers.
#. Stash any local changes to the repo, including any untracked files, with `git stash --include-untracked` to be sure that they won't accidentally be included in the release.
#. In the M-LOOP project root directory, run ``python setup.py sdist`` to make the source distribution.

#. Create a release on Github.

* Go to `https://github.com/michaelhush/M-LOOP/releases <https://github.com/michaelhush/M-LOOP/releases>`_ and press "Draft a new release".
Expand All @@ -50,6 +50,7 @@ This document describes the process for generating new M-LOOP releases and is in

#. Do a dry run publishing to TestPyPI by running ``twine upload --repository testpypi dist/*`` in the M-LOOP project root directory.
#. If the previous step goes well, then run ``twine upload dist/*`` to publish to real PyPI.
#. If any local changes were stashed, you may want to reapply them with `git stash apply`.
#. Build a new documentation version on readthedocs.

* In particular a new version of "stable" should be built.
Expand Down

0 comments on commit cb3a59d

Please sign in to comment.