What I saw
While testing the cpflow 5.0.4 install/update instructions in , I ran:
force .github/cpflow-help.md
force .github/workflows/cpflow-cleanup-stale-review-apps.yml
force .github/workflows/cpflow-delete-review-app.yml
force .github/workflows/cpflow-deploy-review-app.yml
force .github/workflows/cpflow-deploy-staging.yml
force .github/workflows/cpflow-help-command.yml
force .github/workflows/cpflow-promote-staging-to-production.yml
force .github/workflows/cpflow-review-app-help.yml
create bin/pin-cpflow-github-ref
create bin/test-cpflow-github-flow
Updated cpflow GitHub Actions wrappers for cpflow 5.0.4.
Next: review the diff and run bin/test-cpflow-github-flow.
If you run cpflow through Bundler, use bin/test-cpflow-github-flow bundle exec cpflow.
==> cpflow github-flow-readiness
[PASS] Rails app scaffold found (Gemfile, bin/rails, config/application.rb, config.ru).
[PASS] Ruby 3.4.6 is modern enough for rollout.
[PASS] Bundler 2.4.17 is modern enough for rollout.
[PASS] Found production Dockerfile at .controlplane/Dockerfile.
[PASS] All direct Ruby gems resolve from public RubyGems sources.
[PASS] Checked 6 exact-pinned direct Ruby gems; all appear available on RubyGems.
[PASS] Checked 7 exact-pinned direct npm packages; all appear available on npm.
No blocking readiness issues detected. Validate the real production build path before merging.
==> parse generated GitHub Actions YAML
parsed .github/actions/cpflow-build-docker-image/action.yml
parsed .github/actions/cpflow-delete-control-plane-app/action.yml
parsed .github/actions/cpflow-detect-release-phase/action.yml
parsed .github/actions/cpflow-setup-environment/action.yml
parsed .github/actions/cpflow-validate-config/action.yml
parsed .github/actions/cpflow-wait-for-health/action.yml
parsed .github/workflows/claude-code-review.yml
parsed .github/workflows/claude.yml
parsed .github/workflows/cpflow-cleanup-stale-review-apps.yml
parsed .github/workflows/cpflow-delete-review-app.yml
parsed .github/workflows/cpflow-deploy-review-app.yml
parsed .github/workflows/cpflow-deploy-staging.yml
parsed .github/workflows/cpflow-help-command.yml
parsed .github/workflows/cpflow-promote-staging-to-production.yml
parsed .github/workflows/cpflow-review-app-help.yml
parsed .github/workflows/js_test.yml
parsed .github/workflows/lint_test.yml
parsed .github/workflows/rspec_test.yml
==> check composite action input descriptions
no action metadata descriptions contain GitHub expressions
==> check cpflow reusable workflow refs
cpflow refs: v5.0.4
==> actionlint
The workflow wrappers correctly moved to , but the generated included this version-locking example:
Why it is rough
The surrounding generated doc is release-specific: the upstream guide link and wrapper refs point at . Seeing in the same generated help text makes it look like downstream maintainers might need to set an old runtime override.
Expected
Either:
- render the example with the current installed cpflow release, e.g. and , or
- make the example clearly placeholder-based, e.g. with .
Notes
I patched the downstream PR manually for now, but the generator should probably avoid emitting a stale release number.
What I saw
While testing the cpflow 5.0.4 install/update instructions in , I ran:
Updated cpflow GitHub Actions wrappers for cpflow 5.0.4.
Next: review the diff and run
bin/test-cpflow-github-flow.If you run cpflow through Bundler, use
bin/test-cpflow-github-flow bundle exec cpflow.==> cpflow github-flow-readiness
[PASS] Rails app scaffold found (
Gemfile,bin/rails,config/application.rb,config.ru).[PASS] Ruby 3.4.6 is modern enough for rollout.
[PASS] Bundler 2.4.17 is modern enough for rollout.
[PASS] Found production Dockerfile at
.controlplane/Dockerfile.[PASS] All direct Ruby gems resolve from public RubyGems sources.
[PASS] Checked 6 exact-pinned direct Ruby gems; all appear available on RubyGems.
[PASS] Checked 7 exact-pinned direct npm packages; all appear available on npm.
No blocking readiness issues detected. Validate the real production build path before merging.
==> parse generated GitHub Actions YAML
parsed .github/actions/cpflow-build-docker-image/action.yml
parsed .github/actions/cpflow-delete-control-plane-app/action.yml
parsed .github/actions/cpflow-detect-release-phase/action.yml
parsed .github/actions/cpflow-setup-environment/action.yml
parsed .github/actions/cpflow-validate-config/action.yml
parsed .github/actions/cpflow-wait-for-health/action.yml
parsed .github/workflows/claude-code-review.yml
parsed .github/workflows/claude.yml
parsed .github/workflows/cpflow-cleanup-stale-review-apps.yml
parsed .github/workflows/cpflow-delete-review-app.yml
parsed .github/workflows/cpflow-deploy-review-app.yml
parsed .github/workflows/cpflow-deploy-staging.yml
parsed .github/workflows/cpflow-help-command.yml
parsed .github/workflows/cpflow-promote-staging-to-production.yml
parsed .github/workflows/cpflow-review-app-help.yml
parsed .github/workflows/js_test.yml
parsed .github/workflows/lint_test.yml
parsed .github/workflows/rspec_test.yml
==> check composite action input descriptions
no action metadata descriptions contain GitHub expressions
==> check cpflow reusable workflow refs
cpflow refs: v5.0.4
==> actionlint
The workflow wrappers correctly moved to , but the generated included this version-locking example:
Why it is rough
The surrounding generated doc is release-specific: the upstream guide link and wrapper refs point at . Seeing in the same generated help text makes it look like downstream maintainers might need to set an old runtime override.
Expected
Either:
Notes
I patched the downstream PR manually for now, but the generator should probably avoid emitting a stale release number.