Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
8 changes: 4 additions & 4 deletions .controlplane/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ Advanced optional variables:
| --- | --- |
| `REVIEW_APP_DEPLOYING_ICON_URL` | Cosmetic custom animated icon for review-app comments. Ignore this for the standard setup. |
| `CPLN_CLI_VERSION` | Pin only when Control Plane CLI compatibility requires it. |
| `CPFLOW_VERSION` | Runtime gem override. Normally leave unset. If set, it must match the workflow tag without the leading `v`, such as `5.0.2`. |
| `CPFLOW_VERSION` | Runtime gem override. Normally leave unset. If set, it must match the workflow tag without the leading `v`, such as `5.0.4`. |

## Control Plane Setup

Expand Down Expand Up @@ -206,7 +206,7 @@ bin/test-cpflow-github-flow ruby /path/to/control-plane-flow/bin/cpflow

This repo is locked at runtime by the generated workflow wrapper GitHub ref, not
by the gem alone. The wrappers currently point their `uses:` refs at the
upstream `control-plane-flow` release tag `v5.0.2`. GitHub loads the reusable
upstream `control-plane-flow` release tag `v5.0.4`. GitHub loads the reusable
workflow from that tag, and the upstream workflow checks out its matching shared
actions from the same workflow context. Downstream wrappers should not pass a
duplicate `control_plane_flow_ref` input.
Expand All @@ -222,7 +222,7 @@ To move to a newer stable `cpflow` release when generated templates changed:

1. Install or bundle the released `cpflow` gem.
2. Run `cpflow generate-github-actions`.
3. Verify the generated wrappers point to the matching tag, such as `v5.0.2`.
3. Verify the generated wrappers point to the matching tag, such as `v5.0.4`.
4. Leave `CPFLOW_VERSION` unset, or set it to the same RubyGems version without
the leading `v`. For prereleases, use dot syntax such as `5.0.0.rc.1`.
5. Run `bin/test-cpflow-github-flow`.
Expand All @@ -231,7 +231,7 @@ If the generated files are already current and only the upstream tag needs to
move, run:

```sh
bin/pin-cpflow-github-ref v5.0.2
bin/pin-cpflow-github-ref v5.0.4
```

When testing unreleased `control-plane-flow` changes before a release, pin the
Expand Down
8 changes: 4 additions & 4 deletions .github/cpflow-help.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

These commands are generated by [cpflow](https://github.com/shakacode/control-plane-flow).
For full setup, version-pinning, and troubleshooting details, see the upstream
[CI automation guide](https://github.com/shakacode/control-plane-flow/blob/v5.0.2/docs/ci-automation.md).
[CI automation guide](https://github.com/shakacode/control-plane-flow/blob/v5.0.4/docs/ci-automation.md).

## Pull Request Commands

Expand Down Expand Up @@ -81,7 +81,7 @@ production org, using production-only secrets and values.
## Version Locking

Generated wrappers pin Control Plane Flow once with the reusable workflow
`uses:` ref, for example `@v5.0.2`. For stable releases,
`uses:` ref, for example `@v5.0.4`. For stable releases,
this ref should be a release tag. The upstream reusable workflow automatically
loads its matching shared actions from GitHub's workflow context, so downstream
wrappers should not pass a duplicate Control Plane Flow ref input. If your
Expand All @@ -96,8 +96,8 @@ exactly matches the same released gem.

Leave `CPFLOW_VERSION` unset so the workflow builds cpflow from the same
checked-out upstream source. If you set `CPFLOW_VERSION`, it must match the
release tag, for example `CPFLOW_VERSION=5.0.2` with a wrapper pinned to
`uses: ...@v5.0.2`.
release tag, for example `CPFLOW_VERSION=5.0.4` with a wrapper pinned to
`uses: ...@v5.0.4`.

Do not leave downstream apps pinned to a moving branch such as `main`. For a
short-lived test of an unreleased upstream PR, pin to a full 40-character commit
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/cpflow-cleanup-stale-review-apps.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,6 @@ jobs:
cleanup:
# Cleanup targets the current inferred review-app prefix. If you changed
# naming conventions, manually delete review apps under the old prefix.
uses: shakacode/control-plane-flow/.github/workflows/cpflow-cleanup-stale-review-apps.yml@v5.0.2
uses: shakacode/control-plane-flow/.github/workflows/cpflow-cleanup-stale-review-apps.yml@v5.0.4
secrets:
CPLN_TOKEN_STAGING: ${{ secrets.CPLN_TOKEN_STAGING }}
2 changes: 1 addition & 1 deletion .github/workflows/cpflow-delete-review-app.yml
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,6 @@ jobs:
github.event_name == 'workflow_dispatch'
# This `if:` mirrors the upstream job guard to avoid a billable workflow_call
# when the event does not match. Keep both conditions in sync.
uses: shakacode/control-plane-flow/.github/workflows/cpflow-delete-review-app.yml@v5.0.2
uses: shakacode/control-plane-flow/.github/workflows/cpflow-delete-review-app.yml@v5.0.4
secrets:
CPLN_TOKEN_STAGING: ${{ secrets.CPLN_TOKEN_STAGING }}
2 changes: 1 addition & 1 deletion .github/workflows/cpflow-deploy-review-app.yml
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ jobs:
github.event.issue.pull_request &&
contains(fromJson('["+review-app-deploy","+review-app-deploy\n","+review-app-deploy\r\n"]'), github.event.comment.body) &&
contains(fromJson('["OWNER","MEMBER","COLLABORATOR"]'), github.event.comment.author_association))
uses: shakacode/control-plane-flow/.github/workflows/cpflow-deploy-review-app.yml@v5.0.2
uses: shakacode/control-plane-flow/.github/workflows/cpflow-deploy-review-app.yml@v5.0.4
secrets:
CPLN_TOKEN_STAGING: ${{ secrets.CPLN_TOKEN_STAGING }}
DOCKER_BUILD_SSH_KEY: ${{ secrets.DOCKER_BUILD_SSH_KEY }}
2 changes: 1 addition & 1 deletion .github/workflows/cpflow-deploy-staging.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ permissions:

jobs:
deploy-staging:
uses: shakacode/control-plane-flow/.github/workflows/cpflow-deploy-staging.yml@v5.0.2
uses: shakacode/control-plane-flow/.github/workflows/cpflow-deploy-staging.yml@v5.0.4
with:
staging_app_branch_default: "main"
secrets:
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/cpflow-help-command.yml
Original file line number Diff line number Diff line change
Expand Up @@ -23,4 +23,4 @@ jobs:
contains(fromJson('["+review-app-help","+review-app-help\n","+review-app-help\r\n"]'), github.event.comment.body) &&
contains(fromJson('["OWNER","MEMBER","COLLABORATOR"]'), github.event.comment.author_association)) ||
github.event_name == 'workflow_dispatch'
uses: shakacode/control-plane-flow/.github/workflows/cpflow-help-command.yml@v5.0.2
uses: shakacode/control-plane-flow/.github/workflows/cpflow-help-command.yml@v5.0.4
2 changes: 1 addition & 1 deletion .github/workflows/cpflow-promote-staging-to-production.yml
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ jobs:
# upgrades are auditable and easy to roll forward. If your security policy
# requires immutable refs, run bin/pin-cpflow-github-ref with the full
# 40-character commit SHA behind the release tag and update the docs too.
uses: shakacode/control-plane-flow/.github/workflows/cpflow-promote-staging-to-production.yml@v5.0.2
uses: shakacode/control-plane-flow/.github/workflows/cpflow-promote-staging-to-production.yml@v5.0.4
with:
# Keep CPLN_TOKEN_PRODUCTION as a secret on this protected GitHub
# Environment. The caller passes the environment name, the upstream
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/cpflow-review-app-help.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,4 +18,4 @@ jobs:
# to PR-open help. Remove it, or uncomment and adapt this guard, if forks or
# clones should stay quiet until Control Plane is configured:
# if: vars.REVIEW_APP_PREFIX != '' || vars.CPLN_ORG_STAGING != ''
uses: shakacode/control-plane-flow/.github/workflows/cpflow-review-app-help.yml@v5.0.2
uses: shakacode/control-plane-flow/.github/workflows/cpflow-review-app-help.yml@v5.0.4
Loading