Skip to content

Commit

Permalink
Prepare 0.5.1 Release (#54)
Browse files Browse the repository at this point in the history
* bump version

* update changelog

* update release notes
  • Loading branch information
nllong authored Oct 15, 2024
1 parent fe20ad0 commit e365d31
Show file tree
Hide file tree
Showing 3 changed files with 25 additions and 7 deletions.
24 changes: 21 additions & 3 deletions CHANGELOG.rst
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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
Expand All @@ -38,6 +55,7 @@ Changelog

0.4.2
-----

What's Changed
**************

Expand Down
6 changes: 3 additions & 3 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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/).
2 changes: 1 addition & 1 deletion setup.cfg
Original file line number Diff line number Diff line change
@@ -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 = [email protected], [email protected], [email protected], [email protected]
Expand Down

0 comments on commit e365d31

Please sign in to comment.