Skip to content

Commit 4fa0659

Browse files
authored
chore(releaser): onboard release-please (#185)
1 parent 9f5547b commit 4fa0659

8 files changed

Lines changed: 84 additions & 446 deletions

File tree

.github/release.yml

Lines changed: 0 additions & 16 deletions
This file was deleted.
Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# SPDX-FileCopyrightText: 2026 DB Systel GmbH
2+
#
3+
# SPDX-License-Identifier: Apache-2.0
4+
5+
name: Release Please
6+
7+
on:
8+
push:
9+
branches:
10+
- main
11+
12+
permissions:
13+
contents: write
14+
issues: write
15+
pull-requests: write
16+
17+
jobs:
18+
release-please:
19+
runs-on: ubuntu-latest
20+
steps:
21+
- uses: actions/create-github-app-token@1b10c78c7865c340bc4f6099eb2f838309f1e8c3 # v3.1.1
22+
id: app-token
23+
with:
24+
client-id: ${{ secrets.RELEASER_CLIENT_ID }}
25+
private-key: ${{ secrets.RELEASER_PRIVATE_KEY }}
26+
27+
- uses: googleapis/release-please-action@5c625bfb5d1ff62eadeeb3772007f7f66fdcf071 # v4.4.1
28+
with:
29+
token: ${{ steps.app-token.outputs.token }}

.release-please-manifest.json

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
{
2+
".": "0.7.7"
3+
}

CONTRIBUTING.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,5 +15,23 @@ Starting development is as easy as installing [uv](https://docs.astral.sh/uv/) a
1515

1616
In order to run the project in the new virtual environment, run `uv run gh-org-mgr`.
1717

18+
## Commit Messages
19+
20+
This project follows the [**Conventional Commits**](https://www.conventionalcommits.org/) specification for commit messages. This is critical to support proper automation of the release process and changelog generation.
21+
22+
## Pull Requests
23+
24+
When contributing to this project, please open a pull request with a clear description of the changes you have made. The **title of your pull request** should follow the conventional commit format (e.g., `feat: add new feature`, `fix: correct a bug`, etc.).
25+
26+
Ensure to use the **Squash and merge** option when merging your pull request.
27+
28+
Both the PR title and merge method are required for a proper release process (see below).
29+
30+
## Release Process
31+
32+
This project uses [release-please](https://github.com/googleapis/release-please) and its respective GitHub Action to automate the release process. This automatically creates a pull request with the version bump and changelog updates whenever a commit is pushed to the default branch. The version bump is determined by the [conventional commit messages](https://www.conventionalcommits.org/) in the commit history since the last release. Once the release pull request is merged, a new release will be published on GitHub.
33+
34+
The relevant configuration for release-please can be found in the `.github/workflows/release-please.yaml` file and the `release-please-config.json` file. Ensure that the branch and project names are correctly set up in the workflow file and configuration file to match your repository's structure.
35+
1836
---
1937
Based on [GitHub's Minimum Viable Governance (MVG)](https://github.com/github/MVG). Licensed under the [CC-BY 4.0 License](https://creativecommons.org/licenses/by/4.0/).

REUSE.toml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
version = 1
2+
3+
[[annotations]]
4+
path = ["release-please-config.json", ".release-please-manifest.json", "CHANGELOG.md"]
5+
SPDX-FileCopyrightText = "2026 OpenRail Association AISBL"
6+
SPDX-License-Identifier = "CC0-1.0"

pyproject.toml

Lines changed: 0 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,6 @@ gh-org-mgr = "gh_org_mgr.manage:main"
4848
dev = [
4949
"ruff>=0.15.10",
5050
"ty>=0.0.29",
51-
"bump-my-version>=1.2.3,<2",
5251
]
5352

5453
[tool.uv]
@@ -87,30 +86,3 @@ convention = "google"
8786
# TY settings
8887
[tool.ty.src]
8988
include = ["gh_org_mgr"]
90-
91-
# Bump-My-Version
92-
[tool.bumpversion]
93-
commit = true
94-
tag = true
95-
sign_tags = true
96-
allow_dirty = false
97-
tag_name = "v{new_version}"
98-
99-
[[tool.bumpversion.files]]
100-
filename = "pyproject.toml"
101-
regex = true
102-
search = "^version = \"{current_version}\""
103-
replace = "version = \"{new_version}\""
104-
105-
[[tool.bumpversion.files]]
106-
filename = "uv.lock"
107-
search = """
108-
[[package]]
109-
name = "github-org-manager"
110-
version = "{current_version}"
111-
"""
112-
replace = """
113-
[[package]]
114-
name = "github-org-manager"
115-
version = "{new_version}"
116-
"""

release-please-config.json

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
{
2+
"$schema": "https://raw.githubusercontent.com/googleapis/release-please/main/schemas/config.json",
3+
"release-type": "python",
4+
"packages": {
5+
".": {
6+
"extra-files": [
7+
{
8+
"path": "uv.lock",
9+
"type": "toml",
10+
"jsonpath": "$.package[?(@.name.value=='github-org-manager')].version"
11+
}
12+
]
13+
}
14+
},
15+
"pull-request-header": ":robot: New Release",
16+
"changelog-sections": [
17+
{ "type": "feat", "section": "🚀 New Features", "hidden": false },
18+
{ "type": "fix", "section": "🔥 Bug Fixes", "hidden": false },
19+
{ "type": "perf", "section": "🏃 Performance Improvements", "hidden": false },
20+
{ "type": "revert", "section": "↩️ Reverts", "hidden": true },
21+
{ "type": "docs", "section": "📚 Documentation", "hidden": false },
22+
{ "type": "refactor", "section": "⌨️ Code Refactoring", "hidden": false },
23+
{ "type": "test", "section": "🧪 Automated Testing", "hidden": false },
24+
{ "type": "build", "section": "🛠️ Build System", "hidden": false },
25+
{ "type": "ci", "section": "📦 CI Improvements", "hidden": false },
26+
{ "type": "chore", "section": "⚙️ Chores", "hidden": false }
27+
]
28+
}

0 commit comments

Comments
 (0)