From 5cc9559f3b5b49be31a0cf2a50ad3efbde01f764 Mon Sep 17 00:00:00 2001 From: Troy Raen Date: Mon, 22 Jul 2024 09:34:09 -0700 Subject: [PATCH] Prep v0.3.10 release (#61) * Prep v0.3.10. Update CHANGELOG.md * improve release documentation --- CHANGELOG.md | 4 ++++ .../for-developers/release-new-version.md | 22 +++++++++---------- 2 files changed, 14 insertions(+), 12 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 826799f..594a312 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -10,6 +10,10 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) ## \[Unreleased\] +(none) + +## \[v0.3.10\] - 2024-07-22 + ### Added - Add `bigquery.Client` class. diff --git a/docs/source/for-developers/release-new-version.md b/docs/source/for-developers/release-new-version.md index e6fed01..4d48dee 100644 --- a/docs/source/for-developers/release-new-version.md +++ b/docs/source/for-developers/release-new-version.md @@ -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: . +- A new version will publish to PyPI here: . +- New documentation will publish to GitHub pages here: . ## Instructions @@ -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. @@ -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).