[CNSL-1934] Add automated pending deploy branch management by linhcrl · Pull Request #105 · cockroachdb/cockroach-cloud-sdk-go

linhcrl · 2026-04-11T03:04:23Z

Introduces two workflows to manage the release process:

pending-deploy-pr.yml (workflow_dispatch trigger):
- Finds the latest automation/pending-deploy-YYYYMMDD-hhmmss branch
- Creates a PR to merge it into main
- Triggers a pending deploy check
pending-deploy-check.yml (pull_request and workflow_dispatch trigger):
- Validates pending deploy PRs before merge
- Checks that Managed-service-commit-SHA trailers reference deployed commits
- Blocks merge until all changes are confirmed deployed in managed-service
- Posts PR comments detailing any undeployed commits

This ensures SDK releases only reference deployed CC API changes.

Testing

Did a mini bug bash testing the SDK release workflows end to end. Here are some test cases I tested for this workflow: https://docs.google.com/spreadsheets/d/1_SJbN6T9XU3_r01guk-KrCYoLQocs6ECaRNghr28X5A?gid=1453507795#gid=1453507795

Example PR: https://github.com/cockroachlabs/cockroach-cloud-sdk-go-automation-testing/pull/184

Relevant screenshots

PR opened by pending-deploy-pr.yml (before all the problematic commits got removed)

Comment left by pending-deploy-check.yml on failed check (before the problematic commits got removed)

fantapop

I left some feedback. In general, this feels like a lot of logic to be inlining into these workflows and going untested. Did you consider the approach we took in the actions repo to separate out some of the logic to actual code files?

fantapop

I left a few nits on this. It would be nice to generate some tests as well for what we can.

linhcrl · 2026-05-12T02:24:00Z

I left a few nits on this. It would be nice to generate some tests as well for what we can.

added some tests

fantapop

I've left some nits and small feedback. signing off though.

fantapop · 2026-05-15T16:37:34Z

+    check_all_commits "release-2024-01-01-1"
+
+    # Check that commit was added to missing_trailer.txt
+    grep -q "abc123|Add new feature" missing_trailer.txt


is there a long opt we can use?

fantapop · 2026-05-15T16:42:51Z

+# Check if the branch has commits not in main
+check_commits() {


nit: This name seems too similar to the check_all_commits function above. Are there some more specific names we can use?

renamed to check_branch_has_new_commits

fantapop · 2026-05-15T16:45:03Z

+    return 0
+  fi
+
+  export GH_TOKEN="$GITHUB_TOKEN"


nit: If possible we should do this further up in the call chain. Having such similar env vars we're shuffling between down here is not ideal.

moved it to right after the validation step

fantapop · 2026-05-15T16:46:38Z

+
+# Check if required commands are available in PATH
+# Usage: check_required_commands "cmd1" "cmd2" "cmd3"
+check_required_commands() {


I see this in the #108 pr as well. Looks like you'll have to do some rebasing.

fantapop · 2026-05-15T16:48:01Z

+  # Fetch the latest managed-service release tag for comparison
+  if ! get_latest_release_tag; then
+    exit 1


Should we log an error here?

fantapop · 2026-05-15T16:49:50Z

+  if [[ -z "${GITHUB_TOKEN:-}" ]]; then
+    log_error "GITHUB_TOKEN environment variable is required"
+    exit 1
+  fi
+
+  if [[ -z "${GITHUB_REPOSITORY:-}" ]]; then
+    log_error "GITHUB_REPOSITORY environment variable is required"
+    exit 1
+  fi
+
+  if [[ -z "${GITHUB_OUTPUT:-}" ]]; then
+    log_error "GITHUB_OUTPUT environment variable is required"
+    exit 1
+  fi


nit: I think I've seen this pattern a few times. We could have a check_required_env vars similar to check_required_params.

Added check_required_env and added some test cases! Great idea, thanks!

Introduces two workflows to manage the release process: 1. pending-deploy-pr.yml (workflow_dispatch trigger): - Finds the latest automation/pending-deploy-YYYYMMDD-hhmmss branch - Creates a PR to merge it into main - Triggers a pending deploy check 2. pending-deploy-check.yml (pull_request and workflow_dispatch trigger): - Validates pending deploy PRs before merge - Checks that Managed-service-commit-SHA trailers reference deployed commits - Blocks merge until all changes are confirmed deployed in managed-service - Posts PR comments detailing any undeployed commits This ensures SDK releases only reference deployed CC API changes. Co-Authored-By: roachdev-claude <roachdev-claude-bot@cockroachlabs.com>

linhcrl changed the title ~~[CNSL-1934] Add automated pending deploy branch management~~ [CNSL-1934] Add pre-release pending deploy branch management Apr 13, 2026

linhcrl force-pushed the pre-release-branch-management branch from f81608f to 427284b Compare April 13, 2026 15:19

linhcrl force-pushed the pre-release-branch-management branch 5 times, most recently from f9a2f35 to cb4189b Compare April 29, 2026 01:10

linhcrl requested a review from fantapop April 29, 2026 01:16

linhcrl force-pushed the pre-release-branch-management branch from cb4189b to 3f5a6bc Compare April 30, 2026 20:46

fantapop reviewed May 1, 2026

View reviewed changes

linhcrl force-pushed the pre-release-branch-management branch 20 times, most recently from 1b798ac to 932dd50 Compare May 7, 2026 02:20

linhcrl force-pushed the pre-release-branch-management branch from 932dd50 to 5a243b1 Compare May 7, 2026 03:15

linhcrl requested a review from fantapop May 7, 2026 03:57

linhcrl force-pushed the pre-release-branch-management branch from 5a243b1 to 3f08d25 Compare May 8, 2026 18:23

linhcrl changed the title ~~[CNSL-1934] Add pre-release pending deploy branch management~~ [CNSL-1934] Add automated pending deploy branch management May 8, 2026

fantapop reviewed May 11, 2026

View reviewed changes

Comment thread scripts/pending-deploy-pr.sh Outdated

Comment thread scripts/pending-deploy-pr.sh Outdated

Comment thread scripts/pending-deploy-pr.sh Outdated

linhcrl force-pushed the pre-release-branch-management branch 5 times, most recently from ba9fc08 to c6b7cac Compare May 12, 2026 00:52

linhcrl requested a review from fantapop May 12, 2026 02:30

linhcrl force-pushed the pre-release-branch-management branch 4 times, most recently from 0427cba to 7b3ab47 Compare May 15, 2026 06:47

fantapop approved these changes May 15, 2026

View reviewed changes

linhcrl force-pushed the pre-release-branch-management branch 3 times, most recently from db3f910 to b0de887 Compare May 15, 2026 21:50

linhcrl force-pushed the pre-release-branch-management branch from b0de887 to d529ed4 Compare May 19, 2026 01:21

linhcrl merged commit 7c37c8c into cockroachdb:main May 19, 2026
2 checks passed

		# Check if the branch has commits not in main
		check_commits() {

Conversation

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

Uh oh!

Testing

Relevant screenshots

PR opened by pending-deploy-pr.yml (before all the problematic commits got removed)

Comment left by pending-deploy-check.yml on failed check (before the problematic commits got removed)

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!

Uh oh!

Uh oh!

Uh oh!

linhcrl commented May 12, 2026

Uh oh!

fantapop left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

linhcrl commented Apr 11, 2026 •

edited

Loading