Repository navigation
chore: use release-please for release automation - #45
Conversation
There was a problem hiding this comment.
Warning
Copilot couldn't run its full agentic review because it didn't start before the timeout. Make sure your repository has a runner available, or add a copilot-code-review.yml file specifying one with the runs-on attribute. See the docs for more details.
Copilot review overview
Review effort: Lite
Findings: 1
Open (2)
What changed in this PR
Adds automated release management using release-please, enforced by Conventional Commit PR titles, and updates workflow/example validation + docs accordingly.
Changes:
- Introduces
release-pleaseconfiguration and arelease.ymlworkflow to open/merge release PRs and movevX/vX.Yalias tags. - Adds PR title validation via
action-semantic-pull-requestto ensure Conventional Commits for squash merges. - Updates workflow/example validation and documentation to reflect the new release flow.
| File | Description |
|---|---|
| release-please-config.json | Configures release-please behavior (release type, changelog path, tag format). |
| .release-please-manifest.json | Seeds the initial version state for release-please. |
| .github/workflows/release.yml | Automates release PRs/tags and moves vX/vX.Y aliases after a release. |
| .github/workflows/pr-title.yml | Enforces Conventional Commit PR titles to drive versioning/changelog generation. |
| bin/check-workflows.sh | Changes example/workflow validation to only require examples for reusable (workflow_call) workflows. |
| .github/workflows/ci-self-check.yml | Updates branch patterns to align with the new release-please branch naming. |
| README.md | Documents that releases are cut via release-please from Conventional Commits. |
| CONTRIBUTING.md | Updates PR checklist to be driven by PR title Conventional Commits instead of manual changelog edits. |
| CHANGELOG.md | Updates changelog guidance to be release-please-generated. |
| AGENTS.md | Documents the new release automation and clarifies which workflows are repo-local. |
| .github/pull_request_template.md | Updates housekeeping to require Conventional Commit PR titles (not manual changelog edits). |
| .github/ISSUE_TEMPLATE/task.md | Updates branching/PR instructions to target main and use Conventional Commit PR titles. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
| - A green `bin/check-workflows.sh` proves input *names* are right, not input *values*. A wrong `build-command` or `artifact-path` only surfaces in a real consumer run. | ||
| - Never hand-edit `CHANGELOG.md` or `.release-please-manifest.json`, and never push a `v*` tag by hand; release-please owns all three. To fix an entry, edit the open release PR. | ||
| - Release PRs and tags created with `GITHUB_TOKEN` do not trigger other workflows, so `ci-self-check.yml` does not run on the release PR. It only touches the changelog and manifest. | ||
| - `cd-github-release.yml` extracts release notes by matching a version heading in `CHANGELOG.md`, and deliberately fails rather than publishing empty notes. Cut `## Unreleased` to `## vX.Y.Z - YYYY-MM-DD` before tagging. |
There was a problem hiding this comment.
I didn't see this cd-github-release.yml, not sure how it fits with the proposed workflow or if it's meant for reuse downstream. Leaving this open for yall to decide how to handle it.
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
There was a problem hiding this comment.
Warning
Copilot couldn't run its full agentic review because it didn't start before the timeout. Make sure your repository has a runner available, or add a copilot-code-review.yml file specifying one with the runs-on attribute. See the docs for more details.
Copilot review overview
Review effort: Lite
Findings: 2
Open (2)
Resolved since last review (1)
There was a problem hiding this comment.
Warning
Copilot couldn't run its full agentic review because it didn't start before the timeout. Make sure your repository has a runner available, or add a copilot-code-review.yml file specifying one with the runs-on attribute. See the docs for more details.
Copilot review overview
Review effort: Lite
Findings: 3
Clarify usage and best practices for shellcheck and release processes. Emphasize the importance of proper versioning and release note extraction. Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Aryan Jasala <aryanjasala@gmail.com>
There was a problem hiding this comment.
Warning
Copilot couldn't run its full agentic review because it didn't start before the timeout. Make sure your repository has a runner available, or add a copilot-code-review.yml file specifying one with the runs-on attribute. See the docs for more details.
Copilot review overview
4 open issues
${{ needs.release-please ... }}is not valid expression syntax because the job id contains a… · New${{ needs.release-please ... }}is not valid expression syntax because the job id contains a… · New These bullets conflict with the newrelease-pleaseflow: (a) you stateCHANGELOG.mdmust not be… This template states<scope>is required in PR titles, but other updated docs in this PR (e.g.,… · New
2 resolved since last review
Review effort: Lite
| move-alias-tags: | ||
| name: Move major and minor alias tags | ||
| needs: release-please | ||
| if: needs.release-please.outputs.release-created == 'true' |
| SHA: ${{ needs.release-please.outputs.sha }} | ||
| MAJOR: ${{ needs.release-please.outputs.major }} | ||
| MINOR: ${{ needs.release-please.outputs.minor }} |
There was a problem hiding this comment.
Warning
Copilot couldn't run its full agentic review because it didn't start before the timeout. Make sure your repository has a runner available, or add a copilot-code-review.yml file specifying one with the runs-on attribute. See the docs for more details.
Copilot review overview
5 open issues
${{ needs.release-please ... }}is not valid expression syntax because the job id contains a…${{ needs.release-please ... }}is not valid expression syntax because the job id contains a… These bullets conflict with the newrelease-pleaseflow: (a) you stateCHANGELOG.mdmust not be… The$schemaURL points at themainbranch, which can change over time and unexpectedly break… · New This template states<scope>is required in PR titles, but other updated docs in this PR (e.g.,…
Review effort: Lite
Nearly everything in this repo is CI, so contributors can't easily tell a ci: change that only touches this repo from a CI change callers see, and a mislabelled caller-facing fix would stay hidden and unreleased. The PR title check no longer accepts ci, which forces the choice: fix/feat when callers see a difference, chore for this repo's own files. release-please now writes Keep a Changelog headings (Added, Fixed, Changed) like the v1.0.0 entry, with docs, chore, refactor, test and build hidden.
release-please for release automationrelease-please for release automation
There was a problem hiding this comment.
Warning
Copilot couldn't run its full agentic review because it didn't start before the timeout. Make sure your repository has a runner available, or add a copilot-code-review.yml file specifying one with the runs-on attribute. See the docs for more details.
Copilot review overview
3 open issues
2 resolved since last review
Review effort: Lite
Brings in rtCamp#44, rtCamp#46, rtCamp#47, rtCamp#48 and rtCamp#49. AGENTS.md keeps this branch's rule that release-please owns CHANGELOG.md, the manifest and v* tags, and takes rtCamp#46's wording for cd-github-release.yml, which is consumer guidance. Drops the hand-written "## Unreleased" section rtCamp#47 added to CHANGELOG.md: release-please inserts each release above the first version heading, so that section would stay stranded above every release. The first release PR lists rtCamp#46 to rtCamp#49 from their titles, and rtCamp#47's fuller notes can go into that PR before it merges.
There was a problem hiding this comment.
Warning
Copilot couldn't run its full agentic review because it didn't start before the timeout. Make sure your repository has a runner available, or add a copilot-code-review.yml file specifying one with the runs-on attribute. See the docs for more details.
Copilot review overview
5 open issues
Usingsecrets.GITHUB_TOKENto create/update the release PR commonly prevents other workflows… · New${{ needs.release-please ... }}is not valid expression syntax because the job id contains a…${{ needs.release-please ... }}is not valid expression syntax because the job id contains a… These bullets conflict with the newrelease-pleaseflow: (a) you stateCHANGELOG.mdmust not be… This line is slightly ambiguous about the source of Conventional Commits. With squash-merge,… · New
Review effort: Lite
| id: release | ||
| uses: googleapis/release-please-action@45996ed1f6d02564a971a2fa1b5860e934307cf7 # v5.0.0 | ||
| with: | ||
| token: ${{ secrets.GITHUB_TOKEN }} |
| ### Changed | ||
|
|
||
| - `ci-lint-js.yml` and `ci-lint-css.yml` no longer pass deleted files to the linter, which failed any change that removed a JS or SCSS file. A removed file, `package.json`, `package-lock.json` or a lint config now lints the whole project with `lint-command`, since any of them can break files the change did not touch: ESLint, Prettier and Babel configs for `ci-lint-js.yml`, and Stylelint configs and `.stylelintignore` for `ci-lint-css.yml`. A `::notice::` names the file that triggered it. `lint-command` is the whole-project command again and no longer receives file arguments. | ||
| Entries are generated by [release-please](https://github.com/googleapis/release-please) from Conventional Commit subjects. Don't edit this file by hand. |



What this PR does
Uses Google's
release-pleasealong with Conventional Commits to automate release handling.Closes
n/a
Changes
pr-title.ymlfor validating PRs follow Conventional Commitsrelease.ymlto generate the release PR, and handle versioning when that PR is mergedcheck-workflowsto handle all reusable workflows (viaworkflow_dispatch) instead of explicitly excludingci-self-check.ymlHow I verified
Migrated from rtcamp/plugin-skeleton-d and axewp/plugin-infra
Acceptance criteria
Runtime behavior
Code quality
Housekeeping
CHANGELOG.mdentry under the current version headingexamples/<workflow>.ymladded or updated to match any input changeyamllint,actionlintandbin/check-workflows.shpass locallyReviewer notes
Screenshots / terminal output
Conventions: AGENTS.md · PR process: CONTRIBUTING.md