Skip to content

Commit

Permalink
Updating deploy notes
Browse files Browse the repository at this point in the history
  • Loading branch information
itsderek23 committed May 10, 2020
1 parent c560735 commit f2e328a
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 3 deletions.
6 changes: 4 additions & 2 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -137,18 +137,20 @@ When running `pytest`, you are testing the source code in the current `venv`. Wh
Deploying
---------

Make sure all your changes are committed (including an entry in HISTORY.rst).
Make sure all your changes are pushed (including an entry in HISTORY.rst) and pass CI tests.
Then run::

$ bump2version patch # possible: major / minor / patch
$ git push
$ git push --tags
$ make release

CircleCI will then deploy to PyPI if tests pass.
We intended to have CircleCI perform the release, but it's having issues with git tags.

If doing a small patch, you can just run:

$ make bump-push
$ make release

CI Setup - Required environment variables
----------------
Expand Down
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ clean-build: ## remove build artifacts
rm -fr dist/
rm -fr .eggs/
find . -name '*.egg-info' -exec rm -fr {} +
find . -name '*.egg' -exec rm -f {} +
find . -name '*.egg' -exec rm -rf {} +

clean-pyc: ## remove Python file artifacts
find . -name '*.pyc' -exec rm -f {} +
Expand Down

0 comments on commit f2e328a

Please sign in to comment.