Skip to content

Let repos define the release PR body #266

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
njuettner merged 3 commits into from
Aug 7, 2026
Merged

Let repos define the release PR body #266

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e14c305
Let repos define the release PR body
njuettner Aug 6, 2026
ccd9837
Pass PR values through the environment, not template expansion
njuettner Aug 6, 2026
3ce84a8
Merge branch 'main' into release-pr-body
njuettner Aug 7, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 23 additions & 1 deletion .github/workflows/create-release-pr.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -297,7 +297,29 @@ jobs:
- name: Create PR
env:
GITHUB_TOKEN: "${{ secrets.TAYLORBOT_GITHUB_ACTION }}"
actor: "${{ github.actor }}"
base: "${{ needs.gather_facts.outputs.base }}"
branch: "${{ needs.gather_facts.outputs.branch }}"
version: "${{ needs.gather_facts.outputs.version }}"
run: |
gh pr create --assignee ${{ github.actor }} --title "chore(release): v${{ env.version }}" --body "" --base ${{ env.base }} --head "${{ needs.gather_facts.outputs.branch }}"
# A repo can ship a release PR body in .github/release-pr-body.md. It is used
# verbatim, so a repo whose CI is triggered from the PR body - e.g. Tekton's
# `/run cluster-test-suites` - gets its tests run on the release PR without
# anyone having to remember to comment. Repos without the file keep an empty
# body, as before.
body_file=".github/release-pr-body.md"
if [ -f "${body_file}" ]; then
echo "Using release PR body from ${body_file}"
body="$(cat "${body_file}")"
else
body=""
fi

# Values come from the step environment rather than template expansions, which
# would be interpolated into the script before it runs.
gh pr create \
--assignee "${actor}" \
--title "chore(release): v${version}" \
--body "${body}" \
--base "${base}" \
--head "${branch}"
6 changes: 6 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,12 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
however this project does not use Semantic Versioning and there are no releases.
Instead this file uses a date-based structure.

## 2026-08-06

### Added

- `create-release-pr`: Use `.github/release-pr-body.md` as the release PR body when a repo ships that file. Release PRs were created with an empty body, so repos whose CI is triggered from the PR body - such as Tekton's `/run cluster-test-suites` - never ran their tests on a release PR unless someone remembered to comment. Repos without the file keep an empty body. Towards https://github.com/giantswarm/roadmap/issues/4334

## 2026-08-05

### Fixed
Expand Down