Skip to content

Use cpflow 5.1.1 release tag#763

Merged
justin808 merged 1 commit into
masterfrom
jg-codex/use-cpflow-5-1-1
Jun 4, 2026
Merged

Use cpflow 5.1.1 release tag#763
justin808 merged 1 commit into
masterfrom
jg-codex/use-cpflow-5-1-1

Conversation

@justin808

@justin808 justin808 commented Jun 4, 2026

Copy link
Copy Markdown
Member

Summary

  • bump bundled cpflow from 5.1.0 to 5.1.1
  • regenerate cpflow GitHub Actions wrappers from the published 5.1.1 gem so workflow refs use v5.1.1
  • update Control Plane docs/help from temporary commit-SHA canary language to the steady-state v5.1.1 release tag path

Verification

  • bin/conductor-exec gem list -r '^cpflow$' -a confirmed 5.1.1 is published
  • git ls-remote --tags https://github.com/shakacode/control-plane-flow.git refs/tags/v5.1.1 confirmed the upstream tag exists
  • bin/conductor-exec bundle check
  • bin/conductor-exec bundle exec cpflow --version -> 5.1.1
  • bin/conductor-exec bundle exec cpflow update-github-actions --staging-branch master
  • bin/conductor-exec bin/test-cpflow-github-flow bundle exec cpflow -> cpflow refs: v5.1.1
  • bin/conductor-exec ruby -e 'require "yaml"; Dir[".github/workflows/*.yml"].sort.each { |path| YAML.load_file(path, aliases: true); puts path }'
  • git diff --check
  • bin/conductor-exec bundle exec rubocop
  • /Users/justin/.agents/skills/autoreview/scripts/autoreview --mode local -> no accepted/actionable findings

Notes

  • bin/conductor-exec bundle exec rspec was attempted locally but blocked because PostgreSQL is not running on /tmp/.s.PGSQL.5432; CI should exercise the suite in its normal environment.

Note

Medium Risk
Changes every cpflow-driven deploy and production promotion workflow ref; risk is limited to a published patch release but still affects CI/CD and promotion paths.

Overview
Bumps the bundled cpflow gem from 5.1.0 to 5.1.1 and aligns all generated Control Plane GitHub Actions wrappers with upstream release tag v5.1.1, replacing the temporary d8877ca… commit-SHA pins.

Reusable workflows for review apps, staging, cleanup, and help now call shakacode/control-plane-flow/...@v5.1.1. Production promotion checks out the same tag and passes control_plane_flow_ref with @v5.1.1 so runtime validation stays in sync with the wrappers.

Docs under .controlplane/ and .github/cpflow-help.md describe v5.1.1 as the steady-state pin (promotion hardening and release-runner timeout fixes) and refresh the update loop to use bundle update cpflow and bundle exec cpflow update-github-actions instead of ad-hoc upstream checkout paths.

Reviewed by Cursor Bugbot for commit e03f7bc. Bugbot is set up for automated code reviews on this repo. Configure here.

Summary by CodeRabbit

  • Chores
    • Updated CI automation workflows to reference control-plane-flow v5.1.1 release version instead of pinned development commits.
    • Upgraded cpflow gem dependency to version 5.1.1.
    • Updated documentation and configuration guidance to align with v5.1.1 release process for control-plane-flow versioning.

@greptile-apps

greptile-apps Bot commented Jun 4, 2026

Copy link
Copy Markdown

Greptile Summary

This PR bumps the bundled cpflow gem from 5.1.0 to 5.1.1 and updates all GitHub Actions reusable-workflow refs from a temporary commit SHA (d8877ca0c9c1d88947f322903e4a4344641029ba) to the corresponding v5.1.1 release tag. Documentation across .controlplane/ and .github/ is updated to remove canary/temporary language and reflect the steady-state release-tag workflow.

  • Gemfile / Gemfile.lock: cpflow pinned to = 5.1.1; no other dependency changes.
  • 6 GitHub Actions workflows: Every uses: ref and the promote-to-production ref: checkout are consistently updated from the commit SHA to v5.1.1.
  • 4 documentation files: Links to the upstream CI automation guide now point to the v5.1.1 tree instead of main; temporary commit-SHA pinning notices are removed.

Confidence Score: 5/5

All changes are mechanical version-string substitutions with no logic, schema, or interface changes; safe to merge.

Every changed line is either a gem version pin, a workflow uses: ref, or a documentation string — all updated consistently from the temporary commit SHA to the v5.1.1 tag. The PR description confirms the tag exists upstream and that bundle exec cpflow --version returns 5.1.1. No new code paths, no renamed identifiers, and no behavioral changes are introduced.

No files require special attention; the promote-to-production workflow is the most sensitive file touched, and its two ref fields (ref: and control_plane_flow_ref) are updated consistently.

Important Files Changed

Filename Overview
Gemfile Bumps cpflow dependency from 5.1.0 to 5.1.1; straightforward patch-version update.
Gemfile.lock Lock file regenerated to reflect cpflow 5.1.1; all other dependency pins unchanged.
.github/workflows/cpflow-promote-staging-to-production.yml Updates both the control-plane-flow checkout ref and the control_plane_flow_ref validation parameter from commit SHA to v5.1.1; changes are consistent with each other.
.github/workflows/cpflow-deploy-review-app.yml Reusable workflow ref updated from commit SHA to v5.1.1 tag; no other changes.
.github/workflows/cpflow-deploy-staging.yml Reusable workflow ref updated from commit SHA to v5.1.1 tag; no other changes.
.github/cpflow-help.md Removes temporary canary language; updates doc link and version locking section to reference v5.1.1 as steady-state.
.controlplane/readme.md Updates three CI automation guide doc links from main branch to v5.1.1 tag; rewrites update-loop instructions to use bundled gem workflow.
.controlplane/shakacode-team.md Removes temporary commit-SHA pinning notice; updates to steady-state v5.1.1 release tag language.
.controlplane/docs/testing-cpflow-github-actions.md Updates CI guide link to v5.1.1 and rewrites testing instructions to reflect the released tag workflow.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A[Gemfile / Gemfile.lock\ncpflow 5.1.0 → 5.1.1] --> B[bundle exec cpflow\nupdate-github-actions]
    B --> C[6 GitHub Actions workflows\nuses: ...@d8877ca → @v5.1.1]
    C --> D1[cpflow-cleanup-stale-review-apps]
    C --> D2[cpflow-delete-review-app]
    C --> D3[cpflow-deploy-review-app]
    C --> D4[cpflow-deploy-staging]
    C --> D5[cpflow-help-command]
    C --> D6[cpflow-review-app-help]
    C --> D7[cpflow-promote-staging-to-production\ncheckout ref + control_plane_flow_ref]
    B --> E[4 doc files\nlinks main → v5.1.1\nremove canary language]
Loading

Reviews (1): Last reviewed commit: "Use cpflow 5.1.1 release tag" | Re-trigger Greptile

@coderabbitai

coderabbitai Bot commented Jun 4, 2026

Copy link
Copy Markdown

Review Change Stack

Walkthrough

This PR pins the entire cpflow CI automation stack from a temporary hardening commit to the stable v5.1.1 release tag. It updates the gem dependency, all GitHub Actions workflow references, and the documentation that guides wrapper version management and upstream testing procedures.

Changes

cpflow v5.1.1 Pin

Layer / File(s) Summary
Gem version and core documentation updates
Gemfile, .controlplane/readme.md, .controlplane/docs/testing-cpflow-github-actions.md, .controlplane/shakacode-team.md
Bump cpflow gem from 5.1.0 to 5.1.1, update all documentation links to the v5.1.1 release guide, and revise testing/wrapper-pinning guidance to describe the new steady-state configuration where release tags are the default and commit SHAs are used only for short-lived upstream testing.
GitHub Actions workflow reference updates
.github/workflows/cpflow-cleanup-stale-review-apps.yml, cpflow-delete-review-app.yml, cpflow-deploy-review-app.yml, cpflow-deploy-staging.yml, cpflow-help-command.yml, cpflow-promote-staging-to-production.yml, cpflow-review-app-help.yml
Update all reusable workflow uses: clauses and the production promotion control_plane_flow_ref input from the pinned commit SHA (d8877ca0c...) to the v5.1.1 tag.
Help and version-locking documentation
.github/cpflow-help.md
Update the version-locking guidance and CI automation guide link to document that generated wrappers and production promotion now pin to the v5.1.1 release tag, replacing the prior description of v5.1.0 with a temporary upstream hardening commit.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related issues

Possibly related PRs

Poem

🐰 From commit hashes to version tags so bright,
Control Plane Flow now sails with v5.1.1's light,
The wrappers all sync, the docs all align,
A stable release—how perfectly fine! ✨

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'Use cpflow 5.1.1 release tag' accurately describes the primary change: updating cpflow from 5.1.0 to 5.1.1 and regenerating workflow refs to use the v5.1.1 release tag.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch jg-codex/use-cpflow-5-1-1

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@github-actions

github-actions Bot commented Jun 4, 2026

Copy link
Copy Markdown

🚀 Quick Review App Commands

Welcome! Here are the commands you can use in this PR:
They require the repository to have cpflow review apps configured, including the CPLN_TOKEN_STAGING secret.

+review-app-deploy

Deploy your PR branch for testing.

+review-app-delete

Remove the review app when done.

+review-app-help

Show detailed instructions, environment setup, and configuration options.

Comment +review-app-help for full setup details.

cpflow_version: ${{ vars.CPFLOW_VERSION }}
# The setup action validates CPFLOW_VERSION against this full workflow ref.
control_plane_flow_ref: shakacode/control-plane-flow/.github/workflows/cpflow-promote-staging-to-production.yml@d8877ca0c9c1d88947f322903e4a4344641029ba
control_plane_flow_ref: shakacode/control-plane-flow/.github/workflows/cpflow-promote-staging-to-production.yml@v5.1.1

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The ref: checkout (line 72) and control_plane_flow_ref here must always use the same tag — a mismatch causes the setup action's CPFLOW_VERSION validation to fail. They're correctly in sync now, but worth calling out explicitly for the next upgrade so both lines get bumped together.

@claude

claude Bot commented Jun 4, 2026

Copy link
Copy Markdown

Review: Use cpflow 5.1.1 release tag

Overall: Clean, well-verified dependency bump — no blocking issues.

What this does

Upgrades cpflow from 5.1.0 to 5.1.1 and replaces the temporary commit-SHA pin (d8877ca) with the stable release tag v5.1.1 across all 7 Control Plane GitHub Actions wrapper workflows and related docs.


Strengths

  • Complete and consistent: All workflow uses: refs, the production checkout ref:, control_plane_flow_ref, Gemfile, Gemfile.lock, and four documentation files are updated in lockstep — confirmed zero remaining d8877ca references.
  • Good verification trail: The PR description documents gem publication, upstream tag existence, local workflow testing, YAML validity, and Rubocop — solid for a CI/CD-path change.
  • Cleaner update loop: Standardizing on bundle update cpflow + bundle exec cpflow update-github-actions is an improvement over the prior ad-hoc upstream-checkout approach.

Considerations

Security — tag mutability (low risk)
The previous pin was an immutable commit SHA; release tags can theoretically be moved. For the first-party shakacode/control-plane-flow repo this is acceptable, and the PR description confirms the tag was verified via git ls-remote --tags before pinning. Notably, the actions/checkout action itself stays on a commit SHA (de0fac2e...), which is the correct practice for third-party actions.

Documentation link pinning
Links in .controlplane/ docs now point to /blob/v5.1.1/ instead of /blob/main/. This is intentional for version consistency but means each future cpflow update must also sweep these links. The revised update loop instructions capture this responsibility.

Test coverage
rspec was not run locally (no PostgreSQL). The CI green signal should be confirmed before merging — not a blocker since this PR only touches CI/CD wrappers and docs, not application code.

coderabbitai[bot]
coderabbitai Bot previously requested changes Jun 4, 2026

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In @.github/workflows/cpflow-promote-staging-to-production.yml:
- Line 72: Replace mutable tag references to shakacode/control-plane-flow with
the immutable commit SHA 610dd36cb9abf14a064003c8d388b8c77c4137d7: change the
actions/checkout usage that currently has "ref: v5.1.1" to use "ref:
610dd36cb9abf14a064003c8d388b8c77c4137d7", and update the variable/setting that
contains "control_plane_flow_ref: ...@v5.1.1" to reference the same commit SHA
instead of the tag.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 3d310358-4bda-434b-a3aa-e5f65401e83d

📥 Commits

Reviewing files that changed from the base of the PR and between 8038797 and e03f7bc.

⛔ Files ignored due to path filters (1)
  • Gemfile.lock is excluded by !**/*.lock
📒 Files selected for processing (12)
  • .controlplane/docs/testing-cpflow-github-actions.md
  • .controlplane/readme.md
  • .controlplane/shakacode-team.md
  • .github/cpflow-help.md
  • .github/workflows/cpflow-cleanup-stale-review-apps.yml
  • .github/workflows/cpflow-delete-review-app.yml
  • .github/workflows/cpflow-deploy-review-app.yml
  • .github/workflows/cpflow-deploy-staging.yml
  • .github/workflows/cpflow-help-command.yml
  • .github/workflows/cpflow-promote-staging-to-production.yml
  • .github/workflows/cpflow-review-app-help.yml
  • Gemfile

Comment thread .github/workflows/cpflow-promote-staging-to-production.yml
@justin808

Copy link
Copy Markdown
Member Author

@coderabbitai resolve

@coderabbitai

coderabbitai Bot commented Jun 4, 2026

Copy link
Copy Markdown
✅ Action performed

Comments resolved and changes approved.

@justin808 justin808 dismissed coderabbitai[bot]’s stale review June 4, 2026 02:21

False positive: this PR intentionally moves generated cpflow wrappers from the unreleased commit-SHA canary to the published v5.1.1 release tag. The 5.1.1 generator emits release-tag refs as steady state; immutable SHAs remain documented for short-lived unreleased upstream tests. Validated with bin/test-cpflow-github-flow bundle exec cpflow reporting cpflow refs: v5.1.1.

@justin808 justin808 merged commit c5f3b16 into master Jun 4, 2026
18 checks passed
@justin808 justin808 deleted the jg-codex/use-cpflow-5-1-1 branch June 4, 2026 02:26
@github-actions

github-actions Bot commented Jun 4, 2026

Copy link
Copy Markdown

✅ Review App Deleted

Review app for PR #763 is deleted

🎮 Control Plane Console
📋 View Workflow Logs

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant