|
2 | 2 |
|
3 | 3 | These commands are generated by [cpflow](https://github.com/shakacode/control-plane-flow). |
4 | 4 | For full setup, version-pinning, and troubleshooting details, see the upstream |
5 | | -[CI automation guide](https://github.com/shakacode/control-plane-flow/blob/main/docs/ci-automation.md). |
| 5 | +[CI automation guide](https://github.com/shakacode/control-plane-flow/blob/c0ca750c4838dacf6a1d81d52cb151301516cb77/docs/ci-automation.md). |
6 | 6 |
|
7 | 7 | ## Pull Request Commands |
8 | 8 |
|
@@ -55,14 +55,18 @@ the environment approval gate passes. |
55 | 55 |
|
56 | 56 | ## Version Locking |
57 | 57 |
|
58 | | -Current wrappers pin both the reusable workflow `uses:` ref and |
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`. |
| 58 | +Generated wrappers pin Control Plane Flow once with the reusable workflow |
| 59 | +`uses:` ref, for example `@c0ca750c4838dacf6a1d81d52cb151301516cb77`. For stable releases, |
| 60 | +this ref should be a release tag. The upstream reusable workflow automatically |
| 61 | +loads its matching shared actions from GitHub's workflow context, so downstream |
| 62 | +wrappers should not pass a duplicate Control Plane Flow ref input. If your |
| 63 | +generated wrappers still include a `with:` block whose only purpose is to repeat |
| 64 | +the same ref, regenerate them with a newer `cpflow`. |
| 65 | + |
62 | 66 | Leave `CPFLOW_VERSION` unset so the workflow builds cpflow from the same |
63 | 67 | checked-out upstream source. If you set `CPFLOW_VERSION`, it must match the |
64 | | -release tag, for example `CPFLOW_VERSION=5.0.1` with |
65 | | -`control_plane_flow_ref: v5.0.1`. |
| 68 | +release tag, for example `CPFLOW_VERSION=5.0.1` with a wrapper pinned to |
| 69 | +`uses: ...@v5.0.1`. |
66 | 70 |
|
67 | 71 | Do not leave downstream apps pinned to a moving branch such as `main`. For a |
68 | 72 | short-lived test of an unreleased upstream PR, pin to a full 40-character commit |
|
0 commit comments