Skip to content

Commit b658fdb

Browse files
authored
update release instructions in DEVELOPMENT.md
1 parent e44eee8 commit b658fdb

File tree

1 file changed

+7
-5
lines changed

1 file changed

+7
-5
lines changed

DEVELOPMENT.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -141,10 +141,12 @@ endings match the project style.
141141
The docs for this repo are hosted by readthedocs.io and can be found [here](https://cleanvision.readthedocs.io/en/latest/).
142142

143143

144-
## Publishing Release
145-
- Ensure all **Checks** are successful for your release related PR after getting approvals from other code maintainers.
144+
## Releasing new version
145+
146146
- Merge all release related PRs.
147+
- Ensure all **Checks** are successful for your release related PR after getting approvals from other code maintainers.
148+
- Check version number listed in pyproject.toml matches desired new version.
147149
- Go to the Releases in the Github repo and draft a new release.
148-
- Create a new tag in the format `v{version}` corresponding to the version being released and click *Generate release notes*.
149-
- Before publishing the release, ensure all checks are satisfied as the release on TestPypi and Pypi is automated and an error will result in publishing a new version.
150-
- Publish release
150+
- Create a new tag in the format `v{version}` corresponding to the version being released, and click *Generate release notes*.
151+
- Once you publish the release in Gitub, there is automated release process in Github Actions that will push to TestPypi and PyPi. However this will error due to permissions, but just ignore these errors and just push to PyPi manually.
152+
- Increment version in pyproject.toml

0 commit comments

Comments
 (0)