diff --git a/.github/workflows/release-please.yml b/.github/workflows/release-please.yml new file mode 100644 index 0000000..bd6f55c --- /dev/null +++ b/.github/workflows/release-please.yml @@ -0,0 +1,20 @@ +name: Release Please + +on: + push: + branches: + - master + +permissions: + contents: write + pull-requests: write + +jobs: + release-please: + runs-on: ubuntu-latest + steps: + # 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 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