Skip to content

Commit

Permalink
update compatability matrix
Browse files Browse the repository at this point in the history
  • Loading branch information
nllong committed Oct 15, 2024
1 parent 52ba111 commit 0e8f903
Showing 1 changed file with 6 additions and 5 deletions.
11 changes: 6 additions & 5 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Compatibility Matrix

* - py-SEED Version
- SEED Version
* - 0.5.0
* - 0.5.0 - current
- 3.1.0
* - 0.4.3
- 2.21.0 - 3.0.0
Expand Down Expand Up @@ -142,11 +142,12 @@ 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
* Create a branch with the prepared release change log.
* Update README's Compatibility matrix, CHANGELOG, and the version in pypoetry.toml.
* Merge branch to develop.
* To release, from the command line merge latest develop into latest main: :code:`git merge --ff-only origin develop`. This will point the HEAD of main to latest develop. Then push the main branch to GitHub with :code:`git push`, 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
* GitHub Actions will automatically prepare the release the new version to PyPi.
* Go to GitHub actions to approve the release.

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/).

0 comments on commit 0e8f903

Please sign in to comment.