From d59f46769c20f890fdda90a51513ba309dc70b0c Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Tue, 9 Dec 2025 13:42:02 +0000 Subject: [PATCH 1/4] Initial plan From 6d891e059985dfa0a81910152c8e752b2cc2d39f Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Tue, 9 Dec 2025 13:44:00 +0000 Subject: [PATCH 2/4] Add Release Please GitHub Action workflow Co-authored-by: joshuabalduff <11274822+joshuabalduff@users.noreply.github.com> --- .github/workflows/release-please.yml | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) create mode 100644 .github/workflows/release-please.yml diff --git a/.github/workflows/release-please.yml b/.github/workflows/release-please.yml new file mode 100644 index 0000000..4b70ad7 --- /dev/null +++ b/.github/workflows/release-please.yml @@ -0,0 +1,18 @@ +name: Release Please + +on: + push: + branches: + - master + +permissions: + contents: write + pull-requests: write + +jobs: + release-please: + runs-on: ubuntu-latest + steps: + - uses: googleapis/release-please-action@v4 + with: + release-type: node From dc6ad08f54e7bca858a6936fa532a3eacf2d8f7d Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Tue, 9 Dec 2025 13:44:48 +0000 Subject: [PATCH 3/4] docs: update CONTRIBUTING.md with Conventional Commits guidelines Co-authored-by: joshuabalduff <11274822+joshuabalduff@users.noreply.github.com> --- CONTRIBUTING.md | 23 ++++++++++++++++------- 1 file changed, 16 insertions(+), 7 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f0f6add..f4d2f73 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -4,15 +4,24 @@ All commits that fix bugs or add features need a test. `` Do not merge code without tests.`` -## Changelog +## Commit Messages + +This repository uses [Conventional Commits](https://www.conventionalcommits.org/) to automate releases and changelog generation via [Release Please](https://github.com/googleapis/release-please). + +Please format your commit messages as: +- `feat:` for new features +- `fix:` for bug fixes +- `docs:` for documentation changes +- `chore:` for maintenance tasks +- `test:` for test-related changes -All commits that change or add to the API must be done in a pull request -that also: +Example: `feat: add new title formatting option` + +Breaking changes should include `BREAKING CHANGE:` in the commit body or add `!` after the type: `feat!: remove legacy API` + +## Changelog -- Add an entry to `CHANGES.md` with clear steps for updating code for - changed or removed API. -- Updates examples -- Updates the docs +Changelogs are automatically generated from commit messages using Release Please. The changelog is updated when releases are created. ### Development From bb4ecf2bd7506a9f3ee22fc7def511dfe65fb3a0 Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Tue, 9 Dec 2025 13:46:10 +0000 Subject: [PATCH 4/4] chore: pin Release Please action to specific version v4.1.3 Co-authored-by: joshuabalduff <11274822+joshuabalduff@users.noreply.github.com> --- .github/workflows/release-please.yml | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/.github/workflows/release-please.yml b/.github/workflows/release-please.yml index 4b70ad7..bd6f55c 100644 --- a/.github/workflows/release-please.yml +++ b/.github/workflows/release-please.yml @@ -13,6 +13,8 @@ jobs: release-please: runs-on: ubuntu-latest steps: - - uses: googleapis/release-please-action@v4 + # Using v4 major version tag which receives security updates while maintaining compatibility + # For stricter version pinning, replace with a specific commit SHA + - uses: googleapis/release-please-action@v4.1.3 with: release-type: node