Skip to content

Commit

Permalink
improve release documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
troyraen committed Jul 22, 2024
1 parent 84dcf8a commit 448bede
Showing 1 changed file with 10 additions and 12 deletions.
22 changes: 10 additions & 12 deletions docs/source/for-developers/release-new-version.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@
# Release a new version of the `pittgoogle-client` package
# Release a new version of pittgoogle-client

This page shows how to release a new version of `pittgoogle-client.
By following these instructions, you will:
This page shows how to release a new version of pittgoogle-client.
Completing these instructions and clicking "Publish" will trigger the following to
happen automatically:

- Tag a new release on GitHub.
- Publish a new version to PyPI.
- Publish new documentation.
- A new release will be tagged on GitHub here: <https://github.com/mwvgroup/pittgoogle-client/releases>.
- A new version will publish to PyPI here: <https://pypi.org/project/pittgoogle-client/>.
- New documentation will publish to GitHub pages here: <https://mwvgroup.github.io/pittgoogle-client/>.

## Instructions

Expand All @@ -21,12 +22,7 @@ By following these instructions, you will:
- Under "Write", paste in the relevant section of CHANGELOG.md describing the release.
- Click "Publish release".

Completing step 3 will (or should):

- Tag a new version on GitHub.
- Publish the documentation to GitHub pages.
- Publish the package to PyPI.org.

Completing step 3 will (or should) cause the new version to be published to the three places listed above.
View the [GitHub Actions](https://github.com/mwvgroup/pittgoogle-client/actions) page to see the
status of the release process.

Expand All @@ -36,4 +32,6 @@ If all went well, you will now be able to install the new version using:
pip install --upgrade pittgoogle-client
```

----

This release process was implemented and described in [pull #7](https://github.com/mwvgroup/pittgoogle-client/pull/7).

0 comments on commit 448bede

Please sign in to comment.