Skip to content

chore: use release-please for release automation - #45

Merged
aryanjasala merged 7 commits into
rtCamp:mainfrom
justlevine:ci/release-please
Nov 5, 2026
Merged

aryanjasala merged 7 commits into
rtCamp:mainfrom
justlevine:ci/release-please

Conversation

@justlevine

Copy link
Copy Markdown
Collaborator

What this PR does

Uses Google's release-please along with Conventional Commits to automate release handling.

Closes

n/a

Changes

  • Adds pr-title.yml for validating PRs follow Conventional Commits
  • Adds release.yml to generate the release PR, and handle versioning when that PR is merged
  • Updates the check-workflows to handle all reusable workflows (via workflow_dispatch) instead of explicitly excluding ci-self-check.yml
  • Update the various docs and mds to reference the new flow.

How I verified

Migrated from rtcamp/plugin-skeleton-d and axewp/plugin-infra

Acceptance criteria

Runtime behavior

  • [ ]

Code quality

  • Lint — zero errors
  • Static analysis — zero errors
  • Tests pass

Housekeeping

  • CHANGELOG.md entry under the current version heading
  • examples/<workflow>.yml added or updated to match any input change
  • yamllint, actionlint and bin/check-workflows.sh pass locally

Reviewer notes

  • Once merged, the repo settings should be changed to default/only-allow squash-merging.

Screenshots / terminal output


Conventions: AGENTS.md · PR process: CONTRIBUTING.md

Copilot AI balanced review requested due to automatic review settings October 4, 2026 12:12

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 Medium severity · 1 Low severity

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-please configuration and a release.yml workflow to open/merge release PRs and move vX/vX.Y alias tags.
  • Adds PR title validation via action-semantic-pull-request to 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.

Comment thread AGENTS.md Outdated
- 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.

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Comment thread .github/workflows/release.yml Resolved
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Copilot AI balanced review requested due to automatic review settings October 4, 2026 14:32

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 Medium severity

Open (2)
Resolved since last review (1)

Comment thread AGENTS.md Resolved
Copilot AI balanced review requested due to automatic review settings October 5, 2026 15:53

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 Medium severity

Open (3)

Comment thread AGENTS.md Resolved
Comment thread .github/workflows/release.yml Resolved
Comment thread .github/workflows/ci-self-check.yml Resolved
Comment thread AGENTS.md Resolved
Comment thread release-please-config.json Resolved
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>
Copilot AI balanced review requested due to automatic review settings November 4, 2026 12:56
Co-authored-by: Aryan Jasala <aryanjasala@gmail.com>

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

move-alias-tags:
name: Move major and minor alias tags
needs: release-please
if: needs.release-please.outputs.release-created == 'true'
Comment on lines +54 to +56
SHA: ${{ needs.release-please.outputs.sha }}
MAJOR: ${{ needs.release-please.outputs.major }}
MINOR: ${{ needs.release-please.outputs.minor }}
Comment thread .github/ISSUE_TEMPLATE/task.md Resolved
Copilot AI balanced review requested due to automatic review settings November 4, 2026 13:14

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Review effort: Lite

Comment thread release-please-config.json Resolved
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.
Copilot AI balanced review requested due to automatic review settings November 5, 2026 08:29
@aryanjasala aryanjasala changed the title ci: use release-please for release automation chore: use release-please for release automation Nov 5, 2026
aryanjasala
aryanjasala previously approved these changes Nov 5, 2026

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.
Copilot AI balanced review requested due to automatic review settings November 5, 2026 08:59

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Review effort: Lite

id: release
uses: googleapis/release-please-action@45996ed1f6d02564a971a2fa1b5860e934307cf7 # v5.0.0
with:
token: ${{ secrets.GITHUB_TOKEN }}
Comment thread CHANGELOG.md
### 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.
@aryanjasala
aryanjasala merged commit 4e19408 into rtCamp:main Nov 5, 2026
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants