@@ -6,21 +6,21 @@ for the Python package and the Konflux takes care of the release process for the
6
6
container image.
7
7
8
8
## Release to PyPI
9
- The package is released to PyPI using the Github Actions. This repository uses
10
- [ release-please] ( https://github.com/googleapis/release-please-action ) that automatically
11
- creates a release PR and updates with every
12
- incoming change. When the release is ready to be released, owner of the repository
13
- should merge the PR. The release-please will automatically create a new release
14
- and update the version in the ` pyproject.toml ` file. The release-please will also
15
- create a new tag for the release.
9
+ A github action is used to release the Python package to PyPI. The action is
10
+ triggered on every version tag (` vX.Y.Z ` ) being pushed to the repository.
16
11
17
- In order for the release-please to work properly a conventional commit
18
- messages are required. The commit messages should follow the
19
- [ conventional commit] ( https://www.conventionalcommits.org/en/v1.0.0/ ) format and
20
- is enforced by the CI.
12
+ ### Release steps:
13
+ 1 . Pull the latest version from the repository. ` git pull upstream main `
14
+ 2 . Increment the version in ` pyproject.toml ` file. The version should be in the format
15
+ ` X.Y.Z ` where ` X ` is the major version, ` Y ` is the minor version and ` Z ` is
16
+ the patch version.
17
+ 3 . Commit the changes to the repository. ` git commit -m "Bump version to X.Y.Z" `
18
+ 4 . Push the changes to the repository. ` git push upstream main `
19
+ 5 . Create a new tag for the release. ` git tag vX.Y.Z `
20
+ 6 . Push the tag to the repository. ` git push upstream vX.Y.Z `
21
21
22
- When a release-please successfully generate a new Github release, another Github
23
- Action will build the package and upload it to PyPI.
22
+ After the tag is pushed, the Github action will be triggered and it will
23
+ automatically build the package and upload it to PyPI.
24
24
25
25
## Release to registry
26
26
The Konflux is used to release the container image to the registry. The Konflux
0 commit comments