Skip to content

docs+ci: registry docs (tfplugindocs) + golangci-lint and docs-drift CI - #8

Merged
PF9-pushkar merged 3 commits into
feat/blockstoragefrom
feat/docs-ci
Jul 12, 2026
Merged

docs+ci: registry docs (tfplugindocs) + golangci-lint and docs-drift CI#8
PF9-pushkar merged 3 commits into
feat/blockstoragefrom
feat/docs-ci

Conversation

@PF9-pushkar

Copy link
Copy Markdown
Collaborator

Docs + CI hardening

Makes the provider registry-ready and tightens CI. Touches every family, so it's stacked on top of the family PRs.

Stacked on feat/blockstorage (#7). Review order: #3#4#5#6#7 → this.

Registry documentation (tfplugindocs)

  • Generated docs/ for all 17 resources and 15 data sources plus the provider index.md, straight from the schema MarkdownDescriptions.
  • make generate runs it; tools/tools.go pins tfplugindocs with the module.

CI (test.yml)

  • golangci-lint (v2.12.2) job + .golangci.yml. Fixed the 4 findings it surfaced (one unused var, one simplifiable return, two redundant embedded-field selectors) — now 0 issues.
  • docs-drift job: regenerates docs and fails if docs/ is stale.
  • Existing build/vet/gofmt/unit + terraform fmt jobs retained.

Verified locally

go build, go vet, gofmt, go test ./internal/..., golangci-lint run, terraform fmt — all clean.

Follow-ups

  • Per-resource examples/ (tfplugindocs will embed usage snippets), authentication & migration guides, subcategory frontmatter to group families in the registry sidebar.

… docs-drift CI

- docs/ generated for all 17 resources and 15 data sources plus the provider index,
  from schema MarkdownDescriptions. `make generate` runs tfplugindocs.
- .golangci.yml (v2) + a golangci-lint CI job; fixed 4 minor lint findings
  (unused var, simplified return, redundant embedded-field selectors).
- test.yml: added lint and docs-drift jobs (generate + git diff on docs/).
- tools/tools.go pins tfplugindocs with the module.
…trix

- gitignore tfplugindocs output (docs/index.md, docs/resources, docs/data-sources);
  keep hand-written docs/compatibility. Docs are generated on demand and at release.
- CI docs job becomes a generate smoke test (no drift check).
- DECISIONS.md: add a VALIDATED-vs-PENDING matrix for the CE lab.
@PF9-pushkar
PF9-pushkar merged commit d3d73ca into feat/blockstorage Jul 12, 2026
4 checks passed
@PF9-pushkar
PF9-pushkar deleted the feat/docs-ci branch July 12, 2026 01:09
PF9-pushkar added a commit that referenced this pull request Jul 12, 2026
chore(ci): re-land docs + CI onto main (lost in #8 stacked merge)
PF9-pushkar added a commit that referenced this pull request Jul 14, 2026
PR #8 was merged into its stacked base (feat/blockstorage) rather than main, so its
changes never reached main. This re-lands them: golangci-lint v2 (.golangci.yml + v7
action) with the 4 lint fixes, tfplugindocs generate target + tools/tools.go, docs
generate CI smoke test, gitignore for generated docs, CHANGELOG, and the CE-lab
validation matrix in DECISIONS.md.
PF9-pushkar added a commit that referenced this pull request Jul 14, 2026
chore(ci): re-land docs + CI onto main (lost in #8 stacked merge)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant