docs: propose ADR for generated SDK lifecycle - #1926
Open
krowvin wants to merge 1 commit into
Open
Conversation
Signed-off-by: Charles Graham, SWT <charles.r.graham@usace.army.mil>
This was referenced Sep 4, 2026
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
This proposes ADR 0017 for the lifecycle of CDA's generated SDKs and adds it to the Design Decisions index. It uses the existing RST ADR structure with Summary, Proposal, Opinions, Decision Status, and References, and is marked proposed.
The proposal defines maintained generator source under
clients/<language>, generation from the corresponding CDA OpenAPI export,cda-*names for new distributions, CDA-aligned release versions, development artifacts for untagged builds, package verification, executable examples, and shared GitHub Pages reference documentation linked from Read the Docs. It keeps higher-level clients separate and preserves the existing cwmsjs name/version scheme pending a separate migration decision.Implementation is being reviewed separately in Python SDK #1925 and SDK Pages #1924. This PR changes documentation only and does not enable publishing or select a PyPI organization.
Validation
git diff --checkpassed.