From e365d314c418c2c4a50aee924ccf07f0c5395d39 Mon Sep 17 00:00:00 2001 From: Nicholas Long <1907354+nllong@users.noreply.github.com> Date: Tue, 15 Oct 2024 09:02:57 -0600 Subject: [PATCH] Prepare 0.5.1 Release (#54) * bump version * update changelog * update release notes --- CHANGELOG.rst | 24 +++++++++++++++++++++--- README.rst | 6 +++--- setup.cfg | 2 +- 3 files changed, 25 insertions(+), 7 deletions(-) diff --git a/CHANGELOG.rst b/CHANGELOG.rst index 25d4b1a..25ad3de 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -1,10 +1,27 @@ Changelog ========= +0.5.1 +----- + +What's Changed +************** + +* Update change log with missing entry by @nllong in https://github.com/SEED-platform/py-seed/pull/52 +* Fix "TaxlotState" -> "TaxLotState" by @AndrewDevetry in https://github.com/SEED-platform/py-seed/pull/53 + +New Contributors +**************** + +* @AndrewDevetry made their first contribution in https://github.com/SEED-platform/py-seed/pull/53 + +**Full Changelog**: https://github.com/SEED-platform/py-seed/compare/v0.5.0...v0.5.1 + 0.5.0 ----- -## What's Changed +What's Changed +************** * Add PyPi release action by @nllong in https://github.com/SEED-platform/py-seed/pull/42 * Update precommit versions by @nllong in https://github.com/SEED-platform/py-seed/pull/44 @@ -14,11 +31,11 @@ Changelog **Full Changelog**: https://github.com/SEED-platform/py-seed/compare/v0.4.3...v0.5.0 - 0.4.3 ----- -## What's Changed +What's Changed +************** * Fix delete cycle progress key and race condition by @nllong in https://github.com/SEED-platform/py-seed/pull/24 * Remove Deprecated APIs, Fix Typos by @axelstudios in https://github.com/SEED-platform/py-seed/pull/23 @@ -38,6 +55,7 @@ Changelog 0.4.2 ----- + What's Changed ************** diff --git a/README.rst b/README.rst index 0746e09..1894f8d 100644 --- a/README.rst +++ b/README.rst @@ -143,10 +143,10 @@ Releasing This project is configured with GitHub Actions to automatically release to PyPi when a new tag is created. To release a new version: * Create a branch with the prepared release change log -* Merge branch to develop, and open PR to main -* Once deployed to main, create a new tag in GitHub against main and copy the change log notes into the tag description +* Merge branch to develop +* To release, from the command line run merge develop into main `git merge --ff-only origin main`. This will point the HEAD of main to latest develop. Then push the main branch to GitHub, which may require a developer with elevated privileges to push to main. +* Back in GitHub create a new tag in GitHub against main and copy the change log notes into the tag description. * GitHub Actions will automatically prepare the release the new version to PyPi * Go to GitHub actions to approve the release -* After merging into main, then in the command line with the develop branch run `git merge origin main` and push the changes. This might have to be done with a person with elevated privileges to bypass the protected branch settings. The GitHub Action required updates to the GitHub repo to only release on tags (https://github.com/SEED-platform/py-seed/settings/environments) after approval and on PyPi to add an authorized publisher (https://pypi.org/manage/project/py-SEED/settings/publishing/). diff --git a/setup.cfg b/setup.cfg index 7f3a7ec..fd55615 100644 --- a/setup.cfg +++ b/setup.cfg @@ -1,6 +1,6 @@ [metadata] name = py-seed -version = 0.5.0 +version = 0.5.1 description = A Python API client for the SEED Platform author = Nicholas Long, Katherine Fleming, Fable Turas, Paul Munday author_email = nicholas.long@nrel.gov, katherine.fleming@nrel.gov, fable@raintechpdx.com, paul@paulmunday.net