create-release-pr: Add create-release-pr reusable workflow by linhcrl · Pull Request #20 · cockroachdb/actions

linhcrl · 2026-03-30T23:20:17Z

Automates creation of release pull requests by detecting unreleased changes in CHANGELOG.md, determining the next semantic version, updating the changelog with the release date, and creating a PR from a fork to the upstream repository.

Supports configurable release dates, custom git identity, and optional update scripts for projects that maintain version numbers in multiple files.

Updates release-version-extract action to expose unreleased_changes output, making changelog entries available for use in commit messages and PR bodies.

Co-Authored-By: roachdev-claude roachdev-claude-bot@cockroachlabs.com

Copilot

Pull request overview

Adds a new reusable GitHub workflow to automate version bump PR creation, and extends the existing release-version-extract action to expose unreleased changelog text for use in commit messages and PR bodies.

Changes:

Add .github/workflows/version-bump.yml reusable workflow to generate a version bump branch/commit and open a PR from a fork.
Extend release-version-extract to output unreleased_changes and document the new output in README.md.
Update docs/changelog and bump the actions/checkout version used in the repo test workflow.

Reviewed changes

Copilot reviewed 7 out of 7 changed files in this pull request and generated 4 comments.

Show a summary per file

File	Description
`release-version-extract/action.yml`	Exposes `unreleased_changes` output from the changelog reader step.
`README.md`	Documents `unreleased_changes`, adds docs for `get-workflow-ref`, and documents the new `version-bump` workflow.
`CHANGELOG.md`	Notes the addition of the new `version-bump` reusable workflow.
`.github/workflows/version-bump.yml`	New reusable workflow implementing the version bump PR automation.
`.github/workflows/test.yml`	Updates the checkout action version used in CI.

Comments suppressed due to low confidence (2)

.github/workflows/version-bump.yml:221

The PR body is built with a double-quoted Bash string that directly interpolates steps.extract-version.outputs.unreleased_changes. Changelog content containing quotes/newlines/$()/backticks can break the assignment or trigger shell expansion. Prefer constructing the body using a quoted heredoc (no interpolation) and/or pass the changelog content through an env var to avoid evaluation.
CHANGELOG.md:23
This changelog entry refers to “CHANGELOG” (no extension) while the rest of the repo/docs consistently use CHANGELOG.md. Consider standardizing the filename here to avoid confusion.

### Changed

- `autotag-from-changelog` action: now automatically creates and updates major
  version tags (e.g., `v1`) when pushing semver tags (e.g., `v1.2.3`), allowing

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

.github/workflows/version-bump.yml

.github/workflows/create-release-pr.yml

README.md

release-version-extract/action.yml

.github/workflows/create-release-pr.yml

README.md

.github/workflows/create-release-pr.yml

fantapop

I didn't quite finish but left some feedback

.github/scripts/commit_release_changes.sh

.github/scripts/commit_release_changes_test.sh

.github/workflows/create-release-pr.yml

.github/scripts/update_changelog.sh

.github/scripts/update_changelog_test.sh

fantapop

This is looking really close. I left some nits and one regarding expect_diff.

fantapop · 2026-04-06T05:46:47Z

actions_helpers_test.sh

+test_get_base_branch_gh_failure() {
+  # Test in a directory that's not a git repo - gh should fail
+  (
+    cd "$TMPDIR_TEST"
+    local result
+    result=$(get_base_branch "" "owner/repo" 2>&1)
+    echo "$result" | check_contains "main"
+  )
+}
+expect_success "get_base_branch: falls back to main when gh fails" test_get_base_branch_gh_failure


Is this the the desired behavior? It seems like we might actually just want to fail out.

Updated this to fail, good catch

fantapop · 2026-04-06T05:52:54Z

.github/scripts/commit_release_changes_test.sh

+  echo "$output" | check_contains "File not found"
+  echo "$output" | check_contains "missing_file.txt"


is there more we can match on here to make it clear it's a warning ? i.e. check_contains_pattern "Warning.*missing_file.txt"

.github/scripts/update_changelog_test.sh

fantapop · 2026-04-06T06:09:31Z

test_helpers.sh

+  # Check if diff contains the expected string (exact match, not regex)
+  if echo "$actual_diff" | check_contains "$expected_diff"; then


Are you not worried this guarantee will be too weak? It means the diff could contain extra unexpected stuff but the test would still pass. If you were worried about the readability of including the additional lines you could dial down the diff context to 1 or even 0 to achieve the same effect but with the added bonus it would fail if there were extra things in the diff.

I updated the test helper to accept the full expected diff and updated the function to check for exact match

fantapop · 2026-04-07T16:18:52Z

actions_helpers.sh

+}
+
+# Assert that input contains a given substring.
+# Usage: check_contains "expected" "$file"   (reads file)


Side note, the file reading part of this function seems odd. I went and looked at existing usages of it and it seems like it's for checking that the GITHUB_OUTPUT has the string in it. Almost all of our usages if check_contains are checking to see if a string has another string. I don't think we should change it for this PR but maybe something to consider for a future change.

linhcrl · 2026-04-07T17:46:05Z

@fantapop Updated the test helper to fail if the diff contains two hunks since in our current use cases, we are only expecting one

Automates creation of release pull requests by detecting unreleased changes in CHANGELOG.md, determining the next semantic version, updating the changelog with the release date, and creating a PR from a fork to the upstream repository. Supports optional build scripts for projects that maintain version numbers in multiple files. Updates release-version-extract action to expose unreleased_changes output, making changelog entries available for use in commit messages and PR bodies. Co-Authored-By: roachdev-claude <roachdev-claude-bot@cockroachlabs.com>

fantapop

Nice. Looks sweet!

linhcrl force-pushed the version-bump-workflow branch 3 times, most recently from 60d920f to a74cd2c Compare March 31, 2026 07:31

linhcrl changed the title ~~Add version-bump reusable workflow~~ version-bump: Add version-bump reusable workflow Mar 31, 2026

linhcrl requested a review from fantapop March 31, 2026 07:47

linhcrl mentioned this pull request Mar 31, 2026

DO NOT MERGE - [CNSL-1935] Add automated release PR workflow cockroachdb/cockroach-cloud-sdk-go#95

Open

fantapop requested a review from Copilot March 31, 2026 20:17

Copilot started reviewing on behalf of fantapop March 31, 2026 20:18 View session

linhcrl force-pushed the version-bump-workflow branch 2 times, most recently from d46ea87 to 4744110 Compare March 31, 2026 20:21

Copilot AI reviewed Mar 31, 2026

View reviewed changes

.github/workflows/version-bump.yml Outdated Show resolved Hide resolved

.github/workflows/create-release-pr.yml Outdated Show resolved Hide resolved

README.md Outdated Show resolved Hide resolved

release-version-extract/action.yml Outdated Show resolved Hide resolved

linhcrl force-pushed the version-bump-workflow branch 3 times, most recently from 40eab2b to eb76833 Compare March 31, 2026 20:52

linhcrl changed the title ~~version-bump: Add version-bump reusable workflow~~ create-release-pr: Add create-release-pr reusable workflow Mar 31, 2026

fantapop reviewed Mar 31, 2026

View reviewed changes

linhcrl force-pushed the version-bump-workflow branch 5 times, most recently from 18a7fdc to cdfb6a1 Compare April 3, 2026 21:48

linhcrl requested a review from fantapop April 3, 2026 21:50

fantapop reviewed Apr 4, 2026

View reviewed changes

linhcrl force-pushed the version-bump-workflow branch 7 times, most recently from ea56bad to d852544 Compare April 5, 2026 06:07

linhcrl force-pushed the version-bump-workflow branch 3 times, most recently from 1fa2373 to 79f2591 Compare April 5, 2026 06:41

fantapop reviewed Apr 6, 2026

View reviewed changes

linhcrl force-pushed the version-bump-workflow branch from 79f2591 to c894223 Compare April 7, 2026 05:10

linhcrl requested a review from fantapop April 7, 2026 15:02

fantapop reviewed Apr 7, 2026

View reviewed changes

linhcrl force-pushed the version-bump-workflow branch from c894223 to 23c6384 Compare April 7, 2026 17:44

linhcrl requested a review from fantapop April 7, 2026 17:45

linhcrl force-pushed the version-bump-workflow branch from 23c6384 to fe1dd13 Compare April 7, 2026 18:23

fantapop approved these changes Apr 7, 2026

View reviewed changes

linhcrl merged commit 4ea9194 into main Apr 7, 2026
2 checks passed

linhcrl deleted the version-bump-workflow branch April 7, 2026 19:10

		echo "$output" \| check_contains "File not found"
		echo "$output" \| check_contains "missing_file.txt"

		# Check if diff contains the expected string (exact match, not regex)
		if echo "$actual_diff" \| check_contains "$expected_diff"; then

Conversation

linhcrl commented Mar 30, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

fantapop left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

fantapop left a comment

Choose a reason for hiding this comment

Uh oh!

fantapop Apr 6, 2026

Choose a reason for hiding this comment

Uh oh!

linhcrl Apr 7, 2026

Choose a reason for hiding this comment

Uh oh!

fantapop Apr 6, 2026

Choose a reason for hiding this comment

Uh oh!

linhcrl Apr 7, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

fantapop Apr 6, 2026

Choose a reason for hiding this comment

Uh oh!

linhcrl Apr 7, 2026

Choose a reason for hiding this comment

Uh oh!

fantapop Apr 7, 2026

Choose a reason for hiding this comment

Uh oh!

linhcrl commented Apr 7, 2026

Uh oh!

fantapop left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

linhcrl commented Mar 30, 2026 •

edited

Loading