Skip to content

Add CI checks - #22

Merged
IlyaasK merged 1 commit into
generated-terraform-docsfrom
ci-checks
Jul 2, 2026
Merged

Add CI checks#22
IlyaasK merged 1 commit into
generated-terraform-docsfrom
ci-checks

Conversation

@IlyaasK

@IlyaasK IlyaasK commented Jun 6, 2026

Copy link
Copy Markdown
Collaborator

What changed

  • Added a GitHub Actions CI workflow for PRs and pushes to main.
  • Added scripts/check-docs.sh to regenerate and validate Terraform docs from the real provider schema.
  • Made PR CI follow the eblog-style fast-test boundary with go test -short -timeout=2m ./....
  • Kept Docker out of this CI slice because the provider ships a Go plugin binary, not a container image.
  • Updated docs/teach.md with the CI/test-speed lesson.

Intentionally unsupported

  • No browser/session runtime operations: acquire, release, flush, app invocation, logs, screenshots, live view, or force recovery.
  • No acceptance tests in default CI; real Kernel acceptance remains opt-in via TF_ACC=1, KERNEL_ACC=1, and Kernel credentials.
  • No Docker build, registry push, release signing, or GoReleaser wiring in this slice. Release/security checklist work stays in the next PR.

Tests run

  • bash -n scripts/check-docs.sh
  • terraform fmt -check -recursive examples
  • GOCACHE=/private/tmp/terraform-provider-kernel-ci-go-cache go test -short -timeout=2m ./...
  • GOCACHE=/private/tmp/terraform-provider-kernel-ci-go-cache go vet ./...
  • files="$(gofmt -l cmd internal)"; if [ -n "$files" ]; then echo "$files"; exit 1; fi
  • git diff --check generated-terraform-docs
  • bash scripts/check-docs.sh

Review gates

All five gates passed after the accepted autoreview fix:

  • deslop
  • autoreview
  • thermo-nuclear-code-quality-review
  • dave-cheney-go-review
  • eblog-code-review

Note

Low Risk
CI and documentation drift checks only; no runtime, auth, or provider behavior changes in this diff.

Overview
Adds GitHub Actions CI on pull requests and pushes to main with read-only repo permissions and a 10-minute job timeout.

The workflow runs Go formatting (gofmt on cmd and internal), Terraform example formatting, go test -short -timeout=2m ./..., go vet, and a generated docs gate via new scripts/check-docs.sh. That script regenerates provider docs through scripts/generate-docs.sh and fails CI if docs/index.md, docs/resources, or docs/data-sources drift from what’s committed.

Reviewed by Cursor Bugbot for commit 48e3b33. Bugbot is set up for automated code reviews on this repo. Configure here.

@firetiger-agent

Copy link
Copy Markdown

Firetiger deploy monitoring skipped

This PR didn't match the auto-monitor filter configured on your GitHub connection:

PRs in the kernel, infra, hypeman, and hypeship repos. kernel is a ~mono repo with many logical services underneath, ensure to focus on the implicated service for the PR

Reason: PR targets the generated-terraform-docs branch and appears to be for a Terraform provider repository, not one of the specified repos (kernel, infra, hypeman, hypeship); please opt in manually if deploy monitoring is needed.

To monitor this PR anyway, reply with @firetiger monitor this.

@IlyaasK
IlyaasK force-pushed the generated-terraform-docs branch from 8f2a605 to bd360f1 Compare June 10, 2026 20:13

@cursor cursor Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cursor Bugbot has reviewed your changes and found 1 potential issue.

Fix All in Cursor

❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, enable autofix in the Cursor dashboard.

Reviewed by Cursor Bugbot for commit 9dad510. Configure here.

Comment thread scripts/check-docs.sh
if [ -n "$doc_status" ]; then
echo "$doc_status"
git diff -- docs/index.md docs/resources docs/data-sources
exit 1

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Docs drift check misses paths

Medium Severity

The generated-docs gate only runs git status on docs/index.md, docs/resources, and docs/data-sources. tfplugindocs can also write under docs/guides, docs/functions, and docs/ephemeral-resources, so new or changed files there would not fail CI despite the PR describing detection of any new generated docs.

Fix in Cursor Fix in Web

Reviewed by Cursor Bugbot for commit 9dad510. Configure here.

@IlyaasK
IlyaasK force-pushed the generated-terraform-docs branch from bd360f1 to 3aef6bf Compare June 11, 2026 14:26
@IlyaasK
IlyaasK force-pushed the generated-terraform-docs branch from 3aef6bf to bf05d6c Compare June 11, 2026 14:58
@IlyaasK
IlyaasK force-pushed the generated-terraform-docs branch from bf05d6c to fcd6018 Compare June 11, 2026 15:09
@IlyaasK
IlyaasK force-pushed the generated-terraform-docs branch from fcd6018 to 18ae6de Compare June 12, 2026 14:55
@IlyaasK
IlyaasK force-pushed the generated-terraform-docs branch from 18ae6de to 15631e7 Compare June 15, 2026 19:22
@IlyaasK
IlyaasK force-pushed the generated-terraform-docs branch from 15631e7 to 63ccd25 Compare June 22, 2026 14:17
@IlyaasK
IlyaasK force-pushed the generated-terraform-docs branch from 63ccd25 to b142cbd Compare June 22, 2026 15:04
@IlyaasK
IlyaasK force-pushed the generated-terraform-docs branch from b142cbd to a912f02 Compare June 22, 2026 18:29
@IlyaasK
IlyaasK force-pushed the generated-terraform-docs branch from a912f02 to a915e49 Compare June 26, 2026 14:30
@IlyaasK
IlyaasK force-pushed the generated-terraform-docs branch from a915e49 to 73dd903 Compare June 26, 2026 14:46
@IlyaasK
IlyaasK force-pushed the ci-checks branch 2 times, most recently from 0e49b35 to ff51a9f Compare June 26, 2026 14:59
@IlyaasK
IlyaasK force-pushed the generated-terraform-docs branch from 73dd903 to ddb94b8 Compare June 26, 2026 14:59
@IlyaasK
IlyaasK force-pushed the generated-terraform-docs branch from ddb94b8 to 470915a Compare June 26, 2026 17:19
@IlyaasK
IlyaasK force-pushed the generated-terraform-docs branch from 470915a to ab5c4e6 Compare June 26, 2026 20:02
@IlyaasK
IlyaasK force-pushed the generated-terraform-docs branch from 17c4016 to 5763ea7 Compare June 29, 2026 14:29
@IlyaasK
IlyaasK force-pushed the generated-terraform-docs branch from 5763ea7 to 18e6e18 Compare June 29, 2026 19:14
@IlyaasK
IlyaasK requested review from Sayan- and tnsardesai June 30, 2026 18:03
@IlyaasK
IlyaasK force-pushed the generated-terraform-docs branch from 18e6e18 to 8634e1d Compare July 2, 2026 02:34
@IlyaasK
IlyaasK force-pushed the generated-terraform-docs branch from 8634e1d to 7a7c362 Compare July 2, 2026 02:48
@IlyaasK
IlyaasK force-pushed the generated-terraform-docs branch from 7a7c362 to 942b0b2 Compare July 2, 2026 19:38
@IlyaasK
IlyaasK force-pushed the ci-checks branch 2 times, most recently from 6db4db7 to 95a65af Compare July 2, 2026 19:51
@IlyaasK
IlyaasK force-pushed the generated-terraform-docs branch from 942b0b2 to 07ca4b4 Compare July 2, 2026 19:51
@IlyaasK
IlyaasK force-pushed the generated-terraform-docs branch from 07ca4b4 to 3f446e4 Compare July 2, 2026 20:03
@IlyaasK
IlyaasK force-pushed the generated-terraform-docs branch from 3f446e4 to 5c629a9 Compare July 2, 2026 20:15
@IlyaasK
IlyaasK force-pushed the generated-terraform-docs branch from 5c629a9 to d3feeaf Compare July 2, 2026 20:25
@IlyaasK
IlyaasK force-pushed the generated-terraform-docs branch from d3feeaf to d0f362d Compare July 2, 2026 20:37
@IlyaasK
IlyaasK force-pushed the generated-terraform-docs branch from d0f362d to af26eda Compare July 2, 2026 20:47
@IlyaasK
IlyaasK force-pushed the ci-checks branch 2 times, most recently from 06f19d8 to ee8d5f6 Compare July 2, 2026 20:52
@IlyaasK
IlyaasK force-pushed the generated-terraform-docs branch from af26eda to 8d3c5b2 Compare July 2, 2026 20:52
@IlyaasK
IlyaasK force-pushed the generated-terraform-docs branch from 8d3c5b2 to 585d3fb Compare July 2, 2026 20:57
@IlyaasK
IlyaasK merged commit d495d12 into generated-terraform-docs Jul 2, 2026
3 checks passed
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.

2 participants