docs(plan): design for live-deployment example validation CI matrix#727
Merged
Merged
Conversation
Files a design doc for the live-deploy CI matrix deferred from the 2026-05-19 multi-repo QoL sweep. Schema-level validation is insufficient to promote a plugin to 'verified'; this design adds a weekly OIDC-driven GitHub Actions matrix that exercises each IaC plugin's examples/minimal/config.yaml against staging cloud accounts, auto-promotes on green, demotes on 2 consecutive REDs. Execution gated on operator provisioning staging accounts + GitHub OIDC trust per provider. Companion to workflow#725 (marketplace-verify subcommand). Closes #723. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Adds a design doc describing a proposed CI “live-deploy” matrix to validate IaC plugin example configs against real staging cloud accounts (via GitHub OIDC), and to drive automatic promotion/demotion of plugin status in workflow-registry.
Changes:
- Introduces a phased plan for staging account/OIDC setup and a scheduled GitHub Actions matrix to run provider validations.
- Specifies an automated reporting/promotion flow (PRs to
workflow-registry, tracking issues on plugin repos) based on validation outcomes. - Documents assumptions, risks, rollback, and success criteria for operationalizing the matrix.
Comment on lines
+75
to
+76
| - name: wfctl deploy --dry-run | ||
| run: wfctl deploy --dry-run examples/minimal/config.yaml |
Comment on lines
+68
to
+80
| - uses: actions/checkout@v4 | ||
| with: | ||
| repository: GoCodeAlone/workflow-plugin-${{ matrix.plugin }} | ||
| ref: main | ||
| - uses: GoCodeAlone/setup-wfctl@v1 | ||
| - name: Configure cloud auth (${{ matrix.plugin }}) | ||
| run: ./.github/scripts/cloud-auth.sh ${{ matrix.plugin }} | ||
| - name: wfctl deploy --dry-run | ||
| run: wfctl deploy --dry-run examples/minimal/config.yaml | ||
| timeout-minutes: 10 | ||
| - name: Report status | ||
| if: always() | ||
| run: ./.github/scripts/report-validation.sh ${{ matrix.plugin }} ${{ job.status }} |
Comment on lines
+56
to
+60
| permissions: | ||
| id-token: write | ||
| contents: read | ||
| pull-requests: write | ||
| jobs: |
Comment on lines
+98
to
+105
| - The cost of running the matrix weekly is bounded (no idle infra; each example deploys + tears down). Estimated <$5/week if examples are correctly written. | ||
| - Promotion/demotion PRs are admin-mergeable autonomously (per `feedback_admin_override_pr_merge`). | ||
|
|
||
| ## Top doubts | ||
|
|
||
| 1. **Cost runaway.** Examples that fail to tear down can leave cloud infra running. Mitigation: each example must include a teardown step + the workflow runs `wfctl destroy` after `deploy --dry-run` even on failure. Verify in alignment-check. | ||
| 2. **Flaky staging.** Cloud-provider transient errors will cause false demotions. Mitigation: require 2 consecutive RED runs before opening a demotion PR. The first RED opens an investigation issue. | ||
| 3. **wfctl deploy --dry-run semantics differ across providers.** If `--dry-run` is too permissive, the signal is meaningless. Verify each provider's dry-run actually validates IAM/API access, not just YAML. |
| ``` | ||
| STAGING_AWS_ROLE_ARN | ||
| STAGING_GCP_WORKLOAD_IDENTITY_PROVIDER + STAGING_GCP_SERVICE_ACCOUNT | ||
| STAGING_AZURE_TENANT_ID + AZURE_CLIENT_ID + AZURE_SUBSCRIPTION_ID |
| - `wfctl deploy --dry-run` exists for all 5 IaC providers. **Verify before execution** — `digitalocean` has it (used in BMW); `aws`/`gcp`/`azure`/`tofu` need verification. | ||
| - OIDC trust for all 4 cloud providers is achievable from GitHub Actions. True today — all 4 publish official auth actions. | ||
| - The cost of running the matrix weekly is bounded (no idle infra; each example deploys + tears down). Estimated <$5/week if examples are correctly written. | ||
| - Promotion/demotion PRs are admin-mergeable autonomously (per `feedback_admin_override_pr_merge`). |
Comment on lines
+57
to
+80
| id-token: write | ||
| contents: read | ||
| pull-requests: write | ||
| jobs: | ||
| live-deploy: | ||
| strategy: | ||
| fail-fast: false | ||
| matrix: | ||
| plugin: [aws, gcp, azure, digitalocean, tofu] | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - uses: actions/checkout@v4 | ||
| with: | ||
| repository: GoCodeAlone/workflow-plugin-${{ matrix.plugin }} | ||
| ref: main | ||
| - uses: GoCodeAlone/setup-wfctl@v1 | ||
| - name: Configure cloud auth (${{ matrix.plugin }}) | ||
| run: ./.github/scripts/cloud-auth.sh ${{ matrix.plugin }} | ||
| - name: wfctl deploy --dry-run | ||
| run: wfctl deploy --dry-run examples/minimal/config.yaml | ||
| timeout-minutes: 10 | ||
| - name: Report status | ||
| if: always() | ||
| run: ./.github/scripts/report-validation.sh ${{ matrix.plugin }} ${{ job.status }} |
⏱ Benchmark Results✅ No significant performance regressions detected. benchstat comparison (baseline → PR)
|
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Design doc for the live-deploy CI matrix deferred from the 2026-05-19 QoL sweep. Closes #723. Execution gated on operator provisioning staging accounts + GitHub OIDC trust.