docs: ADR 0039 — strict-contracts (c1) ruling + Typed-Provider SDK scaffolding#689
Merged
Merged
Conversation
…affolding Records the resolution of two interlocking decisions made mid-execution of plan-2 (plugin-modules-on-iac): 1. (c1) for plan-2 plugin shipping: aws + gcp v1.1.0 carry strict descriptors backing legacy ModuleProvider Go impls, satisfying wfctl plugin audit without forcing an eager typed-Provider migration. 2. SDK Typed-fields scaffolding (PR #686 #683): IaCServeOptions now carries TypedModules + TypedSteps alongside Modules + Steps; mapBackedProvider implements both contracts; grpc_server's Typed-first → legacy-fallback path is reused. (c2) — relaxing the validator — rejected as eroding the strict-cutover value (decisions/0024). (B1) — eager typed migration — rejected as blocking the Phase B/C deletions per the user's "just get the remaining plugins finished up" mandate. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds ADR 0039 to document the accepted strict-contracts ruling for plan-2 plugin shipping and the related Typed Provider SDK scaffolding direction.
Changes:
- Records the c1 decision: aws/gcp plugins keep legacy providers while adding strict contract descriptors.
- Documents the TypedModules/TypedSteps SDK scaffolding and future typed migration path.
| **Adopt (c1) for plan-2 plugin shipping** + **adopt the SDK Typed-fields extension as future-prep** (workflow PR #686, merged before PR 4/5). | ||
|
|
||
| **(c1) shape (shipped in workflow-plugin-aws PR #15 + workflow-plugin-gcp PR #9):** | ||
| - Each plugin defines `internal/contracts/{aws,gcp}_plan2.proto` declaring strict-typed config / input / output messages for the new module types (`aws.credentials`, `storage.s3`, `step.s3_upload`, `gcp.credentials`, `storage.gcs`). |
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
⏱ Benchmark Results✅ No significant performance regressions detected. benchstat comparison (baseline → PR)
|
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.
Summary
Records the two interlocking decisions made mid-execution of plan-2 (plugin-modules-on-iac):
plugin.contracts.jsonbacking legacysdk.ModuleProviderGo impls. Satisfieswfctl plugin auditwithout forcing an eager typed-Provider migration. Documented at the proto level viainternal/contracts/{aws,gcp}_plan2.proto.IaCServeOptionsnow carriesTypedModules+TypedStepsalongsideModules+Steps;mapBackedProviderimplements both contracts;grpc_server's Typed-first → legacy-fallback path is reused.Decisions also rejected
Related
🤖 Generated with Claude Code