Skip to content

Commit 3763cec

Browse files
committed
docs: remove release process form CONTRIBUTING.md
1 parent dbd91cd commit 3763cec

1 file changed

Lines changed: 0 additions & 34 deletions

File tree

CONTRIBUTING.md

Lines changed: 0 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -50,40 +50,6 @@ source .envrc
5050

5151
> You can use [direnv](https://github.com/direnv/direnv) to automatically activate the environment when you enter the project directory.
5252
53-
## Release Cycle
54-
55-
The project follows an automated release process using GitHub Actions:
56-
57-
1. **Conventional Commits**: All commits should follow the [Conventional Commits](https://www.conventionalcommits.org/) specification.
58-
59-
2. **Release Please PR**: The [Release Please](https://github.com/googleapis/release-please) GitHub Action automatically maintains a release PR that:
60-
61-
- Updates the version in `pyproject.toml`
62-
- Updates the version in `src/balatrollm/__init__.py`
63-
- Updates the `CHANGELOG.md` based on conventional commits
64-
- The PR is continuously updated as new commits are added to the main branch
65-
66-
**Important**: Never manually modify `uv.lock`, `CHANGELOG.md`, or version numbers in `pyproject.toml` or your package's `__init__.py`. These are automatically maintained by the release pipeline.
67-
68-
3. **Version Release**: When ready for a new release, the repository owner merges the Release Please PR, which:
69-
70-
- Triggers the creation of a new Git tag (e.g., `v0.5.1`)
71-
- Creates a GitHub Release with release notes
72-
73-
4. **PyPI Publication**: When a new version tag is pushed, the Release PyPI workflow:
74-
75-
- Builds the Python package
76-
- Publishes it to PyPI using trusted publishing
77-
78-
5. **Lock File Update**: After a release is created, an additional workflow:
79-
80-
- Checks out the repository
81-
- Updates the `uv.lock` file with `uv lock`
82-
- Commits and pushes the updated lock file with the message "chore(deps): update uv.lock for version X.Y.Z"
83-
- This ensures dependencies are properly locked for the new version
84-
85-
This automated process ensures consistent versioning, comprehensive changelogs, reliable package distribution, and up-to-date dependency locks with minimal manual intervention.
86-
8753
## Contributing Strategies
8854

8955
Community members can contribute new playing strategies to enhance BalatroLLM's gameplay variety. Strategies define how the bot approaches decision-making during different game phases.

0 commit comments

Comments
 (0)