@@ -4,22 +4,15 @@ This repository is configured to automatically publish the corresponding [PyPI
44package] ( https://pypi.org/project/cloudevents/ ) and GitHub Tag via GitHub Actions.
55
66To release a new CloudEvents SDK, contributors should bump ` __version__ ` in
7- [ cloudevents] ( cloudevents_v1/__init__.py ) to reflect the new release version. On merge, the action
8- will automatically build and release to PyPI using
9- [ this PyPI GitHub Action] ( https://github.com/pypa/gh-action-pypi-publish ) . This
10- action gets called on all pushes to main (such as a version branch being merged
11- into main), but only releases a new version when the version number has changed. Note,
12- this action assumes pushes to main are version updates. Consequently,
13- [ pypi-release.yml] ( .github/workflows/pypi-release.yml ) will fail if you attempt to
14- push to main without updating ` __version__ ` in
15- [ cloudevents] ( cloudevents_v1/__init__.py ) so don't forget to do so.
7+ ` src/cloudevents/__init__.py ` to reflect the new release version. On merge, the action
8+ will automatically build and release to PyPI. This action gets called on all pushes to main
9+ (such as a version branch being merged into main), but only releases a new version when the
10+ version number has changed. Note, this action assumes pushes to main are version updates.
11+ Consequently, the release workflow will fail if you attempt to push to main without updating
12+ ` __version__ ` in ` src/cloudevents/__init__.py ` so don't forget to do so.
1613
17- After a version update is merged, the script [ pypi_packaging.py] ( pypi_packaging.py )
18- will create a GitHub tag for the new cloudevents version using ` __version__ ` .
19- The script fails if ` __version__ ` and the local pypi version for
20- cloudevents are out of sync. For this reason, [ pypi-release.yml] ( .github/workflows/pypi-release.yml )
21- first must upload the new cloudevents pypi package, and then download the recently updated pypi
22- cloudevents package for [ pypi_packaging.py] ( pypi_packaging.py ) not to fail.
14+ After a version update is merged, a GitHub tag for the new cloudevents version is created
15+ using ` __version__ ` .
2316
2417View the GitHub workflow [ pypi-release.yml] ( .github/workflows/pypi-release.yml ) for
2518more information.
0 commit comments