Skip to content

Commit de12867

Browse files
authored
fix(ci): restore release-please parsing and latest action (#113)
## Summary - restore the latest Release Please action v5.0.0 - reject Markdown bullets in commit override blocks, matching the upstream parser contract - correct the repository instructions and add regression coverage - recover the incomplete v0.22.2 GitHub Release and lifecycle labels - correct the merged override blocks on PRs #108 and #110 ## Validation - `PYTHONPATH=. pytest -q tests/tier1_unit/test_validate_repo.py` (5 passed) - `python scripts/validate_repo.py` - `git diff --check` - workflow YAML parsed successfully BEGIN_COMMIT_OVERRIDE fix(ci): restore release-please parsing and latest action docs: correct Release Please commit override syntax END_COMMIT_OVERRIDE
1 parent c0c22af commit de12867

4 files changed

Lines changed: 21 additions & 8 deletions

File tree

‎.github/workflows/release-please.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ jobs:
2525
client-id: ${{ vars.GH_APP_CLIENT_ID }}
2626
private-key: ${{ secrets.GH_APP_PRIVATE_KEY }}
2727

28-
- uses: googleapis/release-please-action@5c625bfb5d1ff62eadeeb3772007f7f66fdcf071 # v4.4.1
28+
- uses: googleapis/release-please-action@45996ed1f6d02564a971a2fa1b5860e934307cf7 # v5.0.0
2929
with:
3030
token: ${{ steps.app-token.outputs.token }}
3131
config-file: .github/release-please/config.json5

‎AGENTS.md‎

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -240,16 +240,20 @@ So user-facing changes need a `feat:` or `fix:` title.
240240
Every implementation PR body must include a Release Please override block using this exact format:
241241

242242
- Each line is one Conventional Commit entry.
243-
- Format: `- type(scope): description`
244-
- The leading `- ` is required.
243+
- Format: `type(scope): description`
244+
- Do not prefix entries with Markdown bullets. Release Please parses the block as a
245+
commit message, so a leading `- ` makes the entry invalid.
245246

246247
Example:
247248

248249
```text
249250
BEGIN_COMMIT_OVERRIDE
250-
- fix(model): correct seed max from 2^63-1 to 2^32-1
251-
- docs: restore advanced env var detail in .env.example and HOW_TO_RUN.md
251+
fix(model): correct seed max from 2^63-1 to 2^32-1
252+
253+
docs: restore advanced env var detail in .env.example and HOW_TO_RUN.md
252254
END_COMMIT_OVERRIDE
253255
```
254256

255-
One Conventional Commit line per entry; one supported type per entry; no composite headers. Release Please version PRs are exempt. Keep model artifacts and benchmark audio out of PRs.
257+
One Conventional Commit line per entry; separate multiple entries with a blank line; one
258+
supported type per entry; no composite headers. Release Please version PRs are exempt.
259+
Keep model artifacts and benchmark audio out of PRs.

‎scripts/validate_repo.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@
2727
"revert",
2828
)
2929
OVERRIDE_ENTRY_RE = re.compile(
30-
rf"^-? ?({'|'.join(CONVENTIONAL_TYPES)})(?:\([a-z0-9][a-z0-9._/-]*\))?!?: .+$"
30+
rf"^({'|'.join(CONVENTIONAL_TYPES)})(?:\([a-z0-9][a-z0-9._/-]*\))?!?: .+$"
3131
)
3232

3333

@@ -47,7 +47,7 @@ def validate_pr_override_body(body: str) -> None:
4747
if invalid:
4848
raise RuntimeError(
4949
"Release Please override entries must each be a single Conventional Commit line "
50-
"with one supported type and an optional simple scope; "
50+
"without a Markdown list marker, with one supported type and an optional simple scope; "
5151
f"invalid entries: {invalid}"
5252
)
5353

‎tests/tier1_unit/test_validate_repo.py‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,5 +41,14 @@ def test_accepts_entries_without_blank_line_separators(self):
4141
"""
4242
)
4343

44+
def test_rejects_markdown_list_markers(self):
45+
with pytest.raises(RuntimeError, match="without a Markdown list marker"):
46+
validate_pr_override_body(
47+
"""BEGIN_COMMIT_OVERRIDE
48+
- fix(runtime): do not pass a list item to the commit parser
49+
END_COMMIT_OVERRIDE
50+
"""
51+
)
52+
4453
def test_ignores_bodies_without_an_override(self):
4554
validate_pr_override_body("Renovate dependency update")

0 commit comments

Comments
 (0)