Skip to content

Commit f443270

Browse files
committed
Document final cpflow PR pin
1 parent 9be9140 commit f443270

9 files changed

Lines changed: 26 additions & 15 deletions

.controlplane/readme.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -504,7 +504,10 @@ The GitHub settings and Control Plane resources must match the app names in
504504
`REVIEW_APP_PREFIX` unset and let the workflow infer
505505
`qa-react-webpack-rails-tutorial`; generated review apps are named
506506
`qa-react-webpack-rails-tutorial-<PR number>`.
507-
If you have older review apps from the previous `qa-react-webpack-rails-tutorial-pr-<PR number>` naming, delete them manually after this flow lands; cleanup targets the current prefix convention. To inventory old apps, run:
507+
If you have older review apps from the previous
508+
`qa-react-webpack-rails-tutorial-pr-<PR number>` naming, delete them manually
509+
after this flow lands; cleanup targets the current prefix convention. To
510+
inventory old apps, run:
508511

509512
```sh
510513
cpln gvc query --org shakacode-open-source-examples-staging -o yaml --prop name~qa-react-webpack-rails-tutorial-pr-

.controlplane/shakacode-team.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,11 @@ Optional repository settings:
7777
- `HEALTH_CHECK_RETRIES` / `HEALTH_CHECK_INTERVAL`: production health polling controls; defaults to `24` retries and `15` seconds.
7878
- `ROLLBACK_READINESS_RETRIES` / `ROLLBACK_READINESS_INTERVAL`: post-rollback health polling controls; defaults to `24` retries and `15` seconds.
7979

80+
Current workflow wrappers are pinned to upstream `control-plane-flow` PR #318 at
81+
`f3f410ebe622fd60af09b8bdf6eca4617685c64a` for downstream testing. After that
82+
upstream work is released, regenerate or repin the wrappers to the release tag
83+
instead of keeping this PR commit SHA long term.
84+
8085
If staging moves off `master`, update both `STAGING_APP_BRANCH` and the branch
8186
filter in `.github/workflows/cpflow-deploy-staging.yml`.
8287

.github/workflows/cpflow-cleanup-stale-review-apps.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,8 @@ jobs:
1212
cleanup:
1313
# Cleanup targets qa-react-webpack-rails-tutorial-<PR>. Manually delete any
1414
# legacy qa-react-webpack-rails-tutorial-pr-<PR> apps during migration.
15-
uses: shakacode/control-plane-flow/.github/workflows/cpflow-cleanup-stale-review-apps.yml@1d82a6dc510745c3fe9b40b01ea348875a4f1923
15+
uses: shakacode/control-plane-flow/.github/workflows/cpflow-cleanup-stale-review-apps.yml@f3f410ebe622fd60af09b8bdf6eca4617685c64a
1616
with:
17-
control_plane_flow_ref: 1d82a6dc510745c3fe9b40b01ea348875a4f1923
17+
control_plane_flow_ref: f3f410ebe622fd60af09b8bdf6eca4617685c64a
1818
secrets:
1919
CPLN_TOKEN_STAGING: ${{ secrets.CPLN_TOKEN_STAGING }}

.github/workflows/cpflow-delete-review-app.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,8 @@ jobs:
2626
contains(fromJson('["OWNER","MEMBER","COLLABORATOR"]'), github.event.comment.author_association)) ||
2727
(github.event_name == 'pull_request_target' && github.event.action == 'closed') ||
2828
github.event_name == 'workflow_dispatch'
29-
uses: shakacode/control-plane-flow/.github/workflows/cpflow-delete-review-app.yml@1d82a6dc510745c3fe9b40b01ea348875a4f1923
29+
uses: shakacode/control-plane-flow/.github/workflows/cpflow-delete-review-app.yml@f3f410ebe622fd60af09b8bdf6eca4617685c64a
3030
with:
31-
control_plane_flow_ref: 1d82a6dc510745c3fe9b40b01ea348875a4f1923
31+
control_plane_flow_ref: f3f410ebe622fd60af09b8bdf6eca4617685c64a
3232
secrets:
3333
CPLN_TOKEN_STAGING: ${{ secrets.CPLN_TOKEN_STAGING }}

.github/workflows/cpflow-deploy-review-app.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,9 +30,9 @@ jobs:
3030
github.event.issue.pull_request &&
3131
contains(fromJson('["+review-app-deploy","+review-app-deploy\n","+review-app-deploy\r\n"]'), github.event.comment.body) &&
3232
contains(fromJson('["OWNER","MEMBER","COLLABORATOR"]'), github.event.comment.author_association))
33-
uses: shakacode/control-plane-flow/.github/workflows/cpflow-deploy-review-app.yml@1d82a6dc510745c3fe9b40b01ea348875a4f1923
33+
uses: shakacode/control-plane-flow/.github/workflows/cpflow-deploy-review-app.yml@f3f410ebe622fd60af09b8bdf6eca4617685c64a
3434
with:
35-
control_plane_flow_ref: 1d82a6dc510745c3fe9b40b01ea348875a4f1923
35+
control_plane_flow_ref: f3f410ebe622fd60af09b8bdf6eca4617685c64a
3636
secrets:
3737
CPLN_TOKEN_STAGING: ${{ secrets.CPLN_TOKEN_STAGING }}
3838
DOCKER_BUILD_SSH_KEY: ${{ secrets.DOCKER_BUILD_SSH_KEY }}

.github/workflows/cpflow-deploy-staging.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,9 @@ permissions:
1616

1717
jobs:
1818
deploy-staging:
19-
uses: shakacode/control-plane-flow/.github/workflows/cpflow-deploy-staging.yml@1d82a6dc510745c3fe9b40b01ea348875a4f1923
19+
uses: shakacode/control-plane-flow/.github/workflows/cpflow-deploy-staging.yml@f3f410ebe622fd60af09b8bdf6eca4617685c64a
2020
with:
21-
control_plane_flow_ref: 1d82a6dc510745c3fe9b40b01ea348875a4f1923
21+
control_plane_flow_ref: f3f410ebe622fd60af09b8bdf6eca4617685c64a
2222
staging_app_branch_default: ""
2323
secrets:
2424
CPLN_TOKEN_STAGING: ${{ secrets.CPLN_TOKEN_STAGING }}

.github/workflows/cpflow-help-command.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,6 @@ jobs:
2323
contains(fromJson('["+review-app-help","+review-app-help\n","+review-app-help\r\n"]'), github.event.comment.body) &&
2424
contains(fromJson('["OWNER","MEMBER","COLLABORATOR"]'), github.event.comment.author_association)) ||
2525
github.event_name == 'workflow_dispatch'
26-
uses: shakacode/control-plane-flow/.github/workflows/cpflow-help-command.yml@1d82a6dc510745c3fe9b40b01ea348875a4f1923
26+
uses: shakacode/control-plane-flow/.github/workflows/cpflow-help-command.yml@f3f410ebe622fd60af09b8bdf6eca4617685c64a
2727
with:
28-
control_plane_flow_ref: 1d82a6dc510745c3fe9b40b01ea348875a4f1923
28+
control_plane_flow_ref: f3f410ebe622fd60af09b8bdf6eca4617685c64a

.github/workflows/cpflow-promote-staging-to-production.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,9 @@ jobs:
1818
if: github.event.inputs.confirm_promotion == 'promote'
1919
# Keep the @ref in `uses:` and `control_plane_flow_ref` below in sync: the
2020
# first selects the reusable workflow, the second selects its shared actions.
21-
uses: shakacode/control-plane-flow/.github/workflows/cpflow-promote-staging-to-production.yml@1d82a6dc510745c3fe9b40b01ea348875a4f1923
21+
uses: shakacode/control-plane-flow/.github/workflows/cpflow-promote-staging-to-production.yml@f3f410ebe622fd60af09b8bdf6eca4617685c64a
2222
with:
23-
control_plane_flow_ref: 1d82a6dc510745c3fe9b40b01ea348875a4f1923
23+
control_plane_flow_ref: f3f410ebe622fd60af09b8bdf6eca4617685c64a
2424
# Keep CPLN_TOKEN_PRODUCTION as a secret on this protected GitHub
2525
# Environment. The caller passes the environment name, the upstream
2626
# reusable workflow runs its production job in that environment, and

.github/workflows/cpflow-review-app-help.yml

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,9 @@ permissions:
1414

1515
jobs:
1616
show-help:
17-
uses: shakacode/control-plane-flow/.github/workflows/cpflow-review-app-help.yml@1d82a6dc510745c3fe9b40b01ea348875a4f1923
17+
# This is intentionally unconditional: adding this wrapper opts the repo in
18+
# to PR-open help. Remove the wrapper or add a repo-specific `if:` guard if
19+
# review apps should not be advertised before Control Plane is configured.
20+
uses: shakacode/control-plane-flow/.github/workflows/cpflow-review-app-help.yml@f3f410ebe622fd60af09b8bdf6eca4617685c64a
1821
with:
19-
control_plane_flow_ref: 1d82a6dc510745c3fe9b40b01ea348875a4f1923
22+
control_plane_flow_ref: f3f410ebe622fd60af09b8bdf6eca4617685c64a

0 commit comments

Comments
 (0)