Skip to content

Commit bec8ba4

Browse files
authored
Merge pull request #5 from konflux-ci/release-redo
fix: delete release-please actions
2 parents ddb1db7 + 552b033 commit bec8ba4

File tree

3 files changed

+16
-56
lines changed

3 files changed

+16
-56
lines changed

.github/workflows/release-please.yml

-41
This file was deleted.

.github/workflows/release.yaml

+3-2
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
11
---
22
name: Release python package
33
on:
4-
release:
5-
types: [created]
4+
push:
5+
tags:
6+
- 'v*'
67
workflow_dispatch:
78

89
jobs:

docs/release.md

+13-13
Original file line numberDiff line numberDiff line change
@@ -6,21 +6,21 @@ for the Python package and the Konflux takes care of the release process for the
66
container image.
77

88
## 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.
1611

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`
2121

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.
2424

2525
## Release to registry
2626
The Konflux is used to release the container image to the registry. The Konflux

0 commit comments

Comments
 (0)