From 6c9130243464dfd9e8bad4f532aff876386f21d0 Mon Sep 17 00:00:00 2001 From: Jon Langevin Date: Tue, 19 May 2026 11:17:53 -0400 Subject: [PATCH 1/3] docs(aws): add README + examples + experimental banner (QoL sweep) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - Authors README.md from scratch with experimental status banner, module/step/backend capabilities, install instructions, and env var table - 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: https://github.com/GoCodeAlone/workflow/pull/714 Co-Authored-By: Claude Sonnet 4.6 --- .github/ISSUE_TEMPLATE/bug_report.md | 33 ++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 27 ++++++++++ .github/PULL_REQUEST_TEMPLATE.md | 20 ++++++++ CONTRIBUTING.md | 27 ++++++++++ README.md | 62 +++++++++++++++++++++++ examples/minimal/config.yaml | 32 ++++++++++++ 6 files changed, 201 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/PULL_REQUEST_TEMPLATE.md create mode 100644 CONTRIBUTING.md create mode 100644 README.md create mode 100644 examples/minimal/config.yaml diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..2409d98 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,33 @@ +--- +name: Bug report +about: Report a bug in this plugin +title: '[Bug] ' +labels: bug +assignees: '' +--- + +## Describe the bug + +A clear and concise description of what the bug is. + +## To reproduce + +Steps to reproduce the behavior: +1. Config used (redact any secrets) +2. Command run +3. Error output + +## Expected behavior + +What you expected to happen. + +## Environment + +- workflow engine version: +- plugin version: +- Go version: +- OS: + +## Additional context + +Add any other context or logs here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..bfcf5e9 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,27 @@ +--- +name: Feature request +about: Suggest a new capability for this plugin +title: '[Feature] ' +labels: enhancement +assignees: '' +--- + +## Summary + +A one-sentence description of the feature. + +## Motivation + +Why is this feature needed? What problem does it solve? + +## Proposed solution + +How would you like it to work? Include config schema changes if relevant. + +## Alternatives considered + +Any alternative approaches you considered and why you ruled them out. + +## Additional context + +Links, screenshots, or related issues. diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..a510115 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,20 @@ +## Summary + + + +## Motivation + + + +## Test plan + +- [ ] `go build ./...` passes +- [ ] `go vet ./...` passes +- [ ] `go test ./...` passes +- [ ] Manual smoke test (describe) + +## Checklist + +- [ ] CHANGELOG.md updated (Keep-a-Changelog format) +- [ ] No secrets or credentials included +- [ ] One feature or bugfix per PR diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..cdddc97 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,27 @@ +# Contributing to workflow-plugin-aws + +This plugin is part of the [GoCodeAlone/workflow](https://github.com/GoCodeAlone/workflow) ecosystem. + +## Before contributing + +Read the [upstream CONTRIBUTING.md](https://github.com/GoCodeAlone/workflow/blob/main/CONTRIBUTING.md) for general conventions, signing, and review expectations. + +## Local development + +```sh +git clone https://github.com/GoCodeAlone/workflow-plugin-aws.git +cd workflow-plugin-aws +go build ./... +go test ./... +``` + +## Pull requests + +- One feature or bugfix per PR. +- Update CHANGELOG.md with a Keep-a-Changelog entry. +- Add tests covering new behavior. +- Run `go vet ./...` before pushing. + +## Reporting issues + +See the issue templates under `.github/ISSUE_TEMPLATE/`. diff --git a/README.md b/README.md new file mode 100644 index 0000000..0824ef8 --- /dev/null +++ b/README.md @@ -0,0 +1,62 @@ +# workflow-plugin-aws + +> ⚠️ **Experimental** — This plugin compiles and passes its unit tests but has not been validated in any active GoCodeAlone-internal production deployment. Use with caution. Please [open an issue](https://github.com/GoCodeAlone/workflow-plugin-aws/issues/new) if you adopt it so we can promote it to **verified** status. + +[![License](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE) +[![Go Reference](https://pkg.go.dev/badge/github.com/GoCodeAlone/workflow-plugin-aws.svg)](https://pkg.go.dev/github.com/GoCodeAlone/workflow-plugin-aws) + +AWS provider plugin for workflow IaC — manages ECS, EKS, RDS, ElastiCache, VPC, ALB, Route53, ECR, API Gateway, Security Groups, IAM, S3, ACM, and AutoScaling Group resources. + +## What it provides + +**Module types:** +- `iac.provider` — AWS IaC provider (v2 compute-plan dispatch) +- `aws.credentials` — AWS credential configuration module +- `storage.s3` — S3 storage backend module + +**Pipeline step types:** +- `step.s3_upload` — Upload files to S3 from a pipeline step + +**IaC state backends:** +- `s3` — Remote state stored in S3 + +## Install + +```yaml +# In your wfctl.yaml +version: 1 +plugins: + - name: workflow-plugin-aws + version: 2.0.0 + source: github.com/GoCodeAlone/workflow-plugin-aws +``` + +Then: + +```sh +wfctl plugin install +``` + +## Minimal example + +See [`examples/minimal/config.yaml`](examples/minimal/config.yaml). + +**Required environment variables:** + +| Variable | Description | +|----------|-------------| +| `AWS_REGION` | AWS region (e.g. `us-east-1`) | +| `AWS_ACCESS_KEY_ID` | AWS access key ID | +| `AWS_SECRET_ACCESS_KEY` | AWS secret access key | + +Alternatively, configure an IAM role on the host (the plugin respects the standard AWS credential chain). + +## Documentation + +- [Plugin authoring guide (upstream)](https://github.com/GoCodeAlone/workflow/blob/main/docs/PLUGIN_AUTHORING.md) +- [Workflow engine docs](https://github.com/GoCodeAlone/workflow) +- [IaC guide](https://github.com/GoCodeAlone/workflow/blob/main/docs/iac/) + +## License + +MIT. See [LICENSE](LICENSE). diff --git a/examples/minimal/config.yaml b/examples/minimal/config.yaml new file mode 100644 index 0000000..1e0372f --- /dev/null +++ b/examples/minimal/config.yaml @@ -0,0 +1,32 @@ +# workflow-plugin-aws minimal example +# Demonstrates AWS IaC provider configuration. +# Validate with: wfctl validate --skip-unknown-types examples/minimal/config.yaml +# +# Required env vars: AWS_REGION, AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY + +modules: + - name: aws-credentials + type: aws.credentials + config: + region: "${AWS_REGION}" + access_key_id: "${AWS_ACCESS_KEY_ID}" + secret_access_key: "${AWS_SECRET_ACCESS_KEY}" + + - name: aws-provider + type: iac.provider + config: + provider: aws + credentials_module: aws-credentials + +workflows: + pipeline: + trigger: + type: http + config: + path: /deploy + method: POST + steps: + - name: deploy + type: step.log + config: + message: "AWS IaC provider ready. Use wfctl iac apply to provision resources." From 658800c5bd9dde4c7fe3bb96acd3abeb0935a5dd Mon Sep 17 00:00:00 2001 From: Jon Langevin Date: Tue, 19 May 2026 11:26:23 -0400 Subject: [PATCH 2/3] fixup! docs(aws): add README + examples + experimental banner (QoL sweep) Use v-prefixed tag format in install snippet (v2.0.0). Co-Authored-By: Claude Sonnet 4.6 --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 0824ef8..b2026f3 100644 --- a/README.md +++ b/README.md @@ -27,7 +27,7 @@ AWS provider plugin for workflow IaC — manages ECS, EKS, RDS, ElastiCache, VPC version: 1 plugins: - name: workflow-plugin-aws - version: 2.0.0 + version: v2.0.0 source: github.com/GoCodeAlone/workflow-plugin-aws ``` From cf7cf14cbc0f18b3dab88b9c63e821be4b33c65b Mon Sep 17 00:00:00 2001 From: Jon Langevin Date: Tue, 19 May 2026 11:29:04 -0400 Subject: [PATCH 3/3] fixup! docs(aws): add README + examples + experimental banner (QoL sweep) Correct install snippet version to v1.2.1 (latest stable tag from repo root). Co-Authored-By: Claude Sonnet 4.6 --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index b2026f3..9a3ce5d 100644 --- a/README.md +++ b/README.md @@ -27,7 +27,7 @@ AWS provider plugin for workflow IaC — manages ECS, EKS, RDS, ElastiCache, VPC version: 1 plugins: - name: workflow-plugin-aws - version: v2.0.0 + version: v1.2.1 source: github.com/GoCodeAlone/workflow-plugin-aws ```