docs(tofu): add README + examples + experimental banner (QoL sweep)#11
Merged
Conversation
- Authors README.md from scratch with experimental status banner, step capabilities (iac_generate_hcl, tofu_init/plan/apply, state import/export), install instructions, and OpenTofu prerequisite note - Adds examples/minimal/config.yaml (wfctl validate --skip-unknown-types ✅) - Adds CONTRIBUTING.md from shared plugin template - Adds .github/ issue templates and PR template Part of 2026-05-19 multi-repo OSS-readiness QoL sweep. See: GoCodeAlone/workflow#714 Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
There was a problem hiding this comment.
Pull request overview
This PR improves OSS/readability ergonomics for workflow-plugin-tofu by adding top-level documentation, a minimal validated example config, contribution guidance, and GitHub community templates.
Changes:
- Add a new
README.mdwith an experimental-status banner, step-type list, prerequisites, install snippet, and links to upstream docs. - Add
examples/minimal/config.yamldemonstrating HCL generation + init/plan/apply wiring. - Add
CONTRIBUTING.mdplus GitHub PR/issue templates to standardize contributions and reports.
Reviewed changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| README.md | Introduces project overview, step inventory, prerequisites, and installation instructions. |
| examples/minimal/config.yaml | Adds a minimal workflow example demonstrating typical step chaining. |
| CONTRIBUTING.md | Adds contribution guidelines referencing upstream workflow conventions. |
| .github/PULL_REQUEST_TEMPLATE.md | Adds a PR template with test plan + checklist. |
| .github/ISSUE_TEMPLATE/feature_request.md | Adds a feature request issue template. |
| .github/ISSUE_TEMPLATE/bug_report.md | Adds a bug report issue template. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| version: 1 | ||
| plugins: | ||
| - name: workflow-plugin-tofu | ||
| version: 0.1.3 |
Comment on lines
+26
to
+31
| - name: plan | ||
| type: step.tofu_plan | ||
| config: | ||
| working_dir: /tmp/tofu-out | ||
| out_file: /tmp/tofu-out/plan.tfplan | ||
|
|
| ## Pull requests | ||
|
|
||
| - One feature or bugfix per PR. | ||
| - Update CHANGELOG.md with a Keep-a-Changelog entry. |
|
|
||
| ## Checklist | ||
|
|
||
| - [ ] CHANGELOG.md updated (Keep-a-Changelog format) |
…weep) - Pin install snippet to v0.1.2 (latest stable release per plugin.json) - Add CHANGELOG.md (Keep-a-Changelog format) Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
step.tofu_plan has no out_file config — plan_file is implicitly generated as <working_dir>/plan.tfplan and returned in step output. Also adds config key documentation as comments. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
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
README.mdfrom scratch with experimental status banner, full step-type listing (iac_generate_hcl, tofu_init/plan/apply, state import/export), install instructions, and OpenTofu prerequisite noteexamples/minimal/config.yaml— validated withwfctl validate --skip-unknown-types✅CONTRIBUTING.mdfrom shared plugin template.github/issue templates and PR templateTest plan
GOWORK=off go build ./...passesGOWORK=off go vet ./...passeswfctl validate --skip-unknown-types examples/minimal/config.yamlpassesRelated
Part of the 2026-05-19 multi-repo OSS-readiness QoL sweep.
See: GoCodeAlone/workflow#714
🤖 Generated with Claude Code