Skip to content

Commit 4eea355

Browse files
committed
Address cpflow docs review follow-up
1 parent eb25cc6 commit 4eea355

2 files changed

Lines changed: 6 additions & 4 deletions

File tree

.controlplane/shakacode-team.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,8 @@ Advanced optional settings are documented upstream in the
6868

6969
Current workflow wrappers are pinned to upstream `control-plane-flow` PR #318 at
7070
`19ca93eadcba81e7438f26ab55a0f2ca7ace82b0` for downstream testing. After 5.0.1
71-
ships, repin the wrappers to `v5.0.1`.
71+
ships, repin the wrappers to `v5.0.1`; do not treat the temporary SHA as the
72+
steady-state master configuration.
7273

7374
If staging moves off `master`, update both `STAGING_APP_BRANCH` and the branch
7475
filter in `.github/workflows/cpflow-deploy-staging.yml`.

.github/cpflow-help.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
These commands are generated by [cpflow](https://github.com/shakacode/control-plane-flow).
44
For full setup, version-pinning, and troubleshooting details, see the upstream
5-
[CI automation guide](https://github.com/shakacode/control-plane-flow/blob/19ca93eadcba81e7438f26ab55a0f2ca7ace82b0/docs/ci-automation.md).
5+
[CI automation guide](https://github.com/shakacode/control-plane-flow/blob/main/docs/ci-automation.md).
66

77
## Pull Request Commands
88

@@ -56,8 +56,9 @@ the environment approval gate passes.
5656
## Version Locking
5757

5858
Current wrappers pin both the reusable workflow `uses:` ref and
59-
`control_plane_flow_ref` to `19ca93eadcba81e7438f26ab55a0f2ca7ace82b0` for
60-
upstream PR testing. After `cpflow` 5.0.1 ships, switch both refs to `v5.0.1`.
59+
`control_plane_flow_ref` to `19ca93eadcba81e7438f26ab55a0f2ca7ace82b0` only for
60+
upstream PR testing. Do not leave production automation on this temporary SHA:
61+
after `cpflow` 5.0.1 ships, switch both refs to `v5.0.1`.
6162
Leave `CPFLOW_VERSION` unset so the workflow builds cpflow from the same
6263
checked-out upstream source. If you set `CPFLOW_VERSION`, it must match the
6364
release tag, for example `CPFLOW_VERSION=5.0.1` with

0 commit comments

Comments
 (0)