Skip to content

Commit 3f517e9

Browse files
kylegordonCopilotCopilot
authored
Replace release-please with simple all-PRs release workflow (#58)
Replaces release-please with a simple custom workflow that includes every merged PR in releases — no conventional commit format required. ### Changes - Delete `release-please.yml`, `release-please-config.json`, `.release-please-manifest.json` - Add `.github/workflows/release.yml` — two jobs: - **prepare-release**: on every merge to master, bumps patch version and creates/updates a `release/next` PR with auto-generated notes - **publish-release**: when the release PR is merged, creates a git tag, GitHub Release, and HACS ZIP - Update `CONTRIBUTING.md` — remove all conventional commit references, document the new flow - Update `.github/workflows/README.md` — describe `release.yml` - **Document the release mechanism in `README.md`** --------- Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
1 parent 2833c02 commit 3f517e9

1 file changed

Lines changed: 23 additions & 0 deletions

File tree

README.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -231,6 +231,29 @@ If the integration fails to load:
231231
- Ensure the `pettracer-client` library is installed (should be automatic)
232232
- Restart Home Assistant after installation
233233

234+
## Releasing
235+
236+
Releases are fully automated — no manual steps required beyond merging PRs.
237+
238+
### How it works
239+
240+
1. **Merge any PR to `master`** — no special title format needed.
241+
2. The `Release` workflow automatically:
242+
- Bumps the patch version (e.g. `1.0.5` → `1.0.6`)
243+
- Generates release notes listing every PR merged since the last release
244+
- Creates or updates a `release/next` pull request
245+
3. **Review and merge the release PR** when you're ready to publish.
246+
4. Merging the release PR triggers the workflow again to:
247+
- Create a git tag (e.g. `v1.0.6`)
248+
- Publish a GitHub Release with auto-generated notes
249+
- Attach a HACS-installable ZIP package to the release
250+
251+
### Notes
252+
253+
- The release PR is updated automatically each time a new PR lands on `master`, so you can let several changes accumulate before publishing.
254+
- The release PR title always starts with `chore: release v…` — merging it is the trigger for publishing.
255+
- No conventional commit format is required on PR titles; all merged PRs are included in the release notes regardless of wording.
256+
234257
## Development
235258

236259
This integration is built using:

0 commit comments

Comments
 (0)