Repository navigation
docs: keep maintainer process out of registry documentation - #29
Merged
Merged
Conversation
Registry pages were published from docs/ with CI gates, package recipes, signing-key custody, secret names and acceptance-test plumbing, and the generated schema tables exposed internal type names. Move the maintainer procedure to RELEASING.md, rewrite both guides for consumers, link the README to them with an accurate publication state, and render Terraform types as readable names in the generated docs.
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.
What
Split maintainer process out of the documentation published to the Terraform and OpenTofu registries.
RELEASING.md(new) holds the release procedure: validation gates,make package-checksteps, signing-key custody and renewal, secret names, pre-tag checklist, tagging and post-publication checks.docs/guides/releases.mdkeeps its path and slug but becomes a consumer guide: release contents, signature and checksum verification, supported platforms, immutable versions.docs/guides/initial-contract.mdkeeps its path and slug and now states audience; it retains ownership, identity and drift behaviour, IdP andgroup_idwarnings, the authoritative assignment set, import requirements, compatibility limits and the deprecation policy, and drops internal acceptance-test plumbing, issue references and milestone language.CONTRIBUTING.mdreceives the live-acceptance procedure and the upstream overlap policy, plus the rule thatdocs/describes the provider to its users.README.mdreports the actual publication state (0.1.0 in both registries, verified coexistence withintegrations/github), pins a version, and links to the guides andRELEASING.mdinstead of carrying registry and signing instructions.internal/cmd/docs/main.gorenders Terraform types for readers (Set[tftypes.String]becomesSet of String) anddocs/is regenerated.examples/complete/README.mdno longer claims the pinned 0.1.0 is only a release candidate.Why
docs/is served from the tagged commit by both registries, so every published page reaches users as-is. It contained CI graph details, packaging recipes, signing-key custody and backups, repository secret names, accepted-fixture flags and internal issue references, none of which a provider user can act on. The README simultaneously stated the provider was unpublished and that coexistence was unverified, both no longer true.Closes #28
How tested
make check(gofmt, vet, race) andmake build: pass.make docs: idempotent, no unexpected diff.git diff --checkandterraform fmt -check -recursive examples: pass.docs/guides/releases.mdwere executed against the realv0.1.0release: key import succeeded,gpg --verifyreported a good signature from the documented user ID, the primary fingerprint matched3610 065D B825 0D31 A49E C0D5 2845 88A6 1CDA 90B9, and the archive checksum matchedSHA256SUMS.docs/for secret names,GPG_variables,package-check, GoReleaser, workflow files, fixtures and issue references: no matches.Remaining work
None in this change. The pages served for
v0.1.0are immutable, so these corrections reach users with the next published version, which needs its own approval. GitHub App tokens, IdP group lifecycle and data-residency hosts remain unverified and are documented as such.