From 23ff5cfde10cd62235602b4ccbcc0b4390b5765a Mon Sep 17 00:00:00 2001 From: Russell Cohen Date: Sun, 17 May 2026 21:00:08 -0400 Subject: [PATCH] Updating CONTRIBUTING and PR description to explain open/close hack --- CONTRIBUTING.md | 7 ++++--- release-plz.toml | 15 +++++++++++++++ 2 files changed, 19 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0cca96ab..c10ffc5b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -90,9 +90,10 @@ The `release.yml` workflow is authorized to publish releases to the dial9 crates 1. Merge your PRs to `main` using conventional commit messages (e.g. `feat:`, `fix:`, `feat!:` for breaking changes). 2. The release PR will update automatically. Review the changelog and version bumps. 3. If you need to adjust versions (e.g. force a major bump), edit `Cargo.toml` versions in the release PR before merging. -4. Merge the release PR. -5. Go to Actions → "Publish release" → Run workflow → confirm. -6. A team member approves the deployment in the `release` environment. +4. **Trigger CI:** The release PR is created by `GITHUB_TOKEN`, which means GitHub won't automatically trigger CI workflows on it. Before merging, close and reopen the PR to trigger CI. Wait for the `CI Pass` check to go green. +5. Merge the release PR. +6. Go to Actions → "Publish release" → Run workflow → confirm. +7. A team member approves the deployment in the `release` environment. ### Semver checks diff --git a/release-plz.toml b/release-plz.toml index cfd4180e..2c7e886a 100644 --- a/release-plz.toml +++ b/release-plz.toml @@ -2,6 +2,21 @@ git_release_enable = true changelog_update = false semver_check = true +pr_body = """ +{% for release in releases %} +{% if release.title %} +### {{release.title}} +{% endif %} +Package: `{{release.package}}` {{release.previous_version}} -> {{release.next_version}} +{% if release.changelog %} +Changes: +{{release.changelog}} +{% endif %} +{% endfor %} +--- + +> **Maintainer note:** CI does not trigger automatically on this PR (GitHub limitation with `GITHUB_TOKEN`-created PRs). **Close and reopen** this PR to trigger CI before merging. +""" [[package]] name = "dial9-tokio-telemetry"