From a87fcac6ac4cdff30291fa61e87500711bd10338 Mon Sep 17 00:00:00 2001 From: Jon Langevin Date: Tue, 19 May 2026 11:19:44 -0400 Subject: [PATCH 1/2] docs(azure): add README + examples + experimental banner (QoL sweep) - Adds README.md with experimental banner, module types (iac.provider), IaC state backends (azure_blob), install instructions, and required env vars (AZURE_SUBSCRIPTION_ID, AZURE_TENANT_ID, AZURE_CLIENT_ID, AZURE_CLIENT_SECRET). - Adds CONTRIBUTING.md from shared plugin template. - Adds examples/minimal/config.yaml (passes wfctl validate). - Adds .github/PULL_REQUEST_TEMPLATE.md + ISSUE_TEMPLATE/*. Co-Authored-By: Claude Opus 4.7 (1M context) --- .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 | 47 +++++++++++++++++++++++ examples/minimal/config.yaml | 14 +++++++ 6 files changed, 168 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..8cf0cd3 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,27 @@ +# Contributing to workflow-plugin-azure + +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-azure.git +cd workflow-plugin-azure +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..66033df --- /dev/null +++ b/README.md @@ -0,0 +1,47 @@ +# workflow-plugin-azure + +> ⚠️ **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-azure/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-azure.svg)](https://pkg.go.dev/github.com/GoCodeAlone/workflow-plugin-azure) + +Azure provider plugin for workflow IaC — manages ACI, AKS, SQL, Redis, VNet, LB, DNS, ACR, APIM, NSG, MSI, Blob Storage, and App Service Certificates. + +## What it provides + +**Module types:** +- `iac.provider` — Azure infrastructure provider + +**IaC state backends:** +- `azure_blob` — Azure Blob Storage state backend + +## Install + +```yaml +# In your wfctl.yaml +version: 1 +plugins: + - name: workflow-plugin-azure + version: v2.0.0 + source: github.com/GoCodeAlone/workflow-plugin-azure +``` + +Then: +```sh +wfctl plugin install +``` + +## Minimal example + +See `examples/minimal/config.yaml`. + +Required env vars: `AZURE_SUBSCRIPTION_ID`, `AZURE_TENANT_ID`, `AZURE_CLIENT_ID`, `AZURE_CLIENT_SECRET`. + +## Documentation + +- [Plugin authoring guide (upstream)](https://github.com/GoCodeAlone/workflow/blob/main/docs/PLUGIN_AUTHORING.md) +- [Workflow engine docs](https://github.com/GoCodeAlone/workflow) + +## License + +MIT. See [LICENSE](LICENSE). diff --git a/examples/minimal/config.yaml b/examples/minimal/config.yaml new file mode 100644 index 0000000..0ab4787 --- /dev/null +++ b/examples/minimal/config.yaml @@ -0,0 +1,14 @@ +# Minimal workflow-plugin-azure example +# Requires: AZURE_SUBSCRIPTION_ID, AZURE_TENANT_ID, AZURE_CLIENT_ID, AZURE_CLIENT_SECRET env vars + +version: 1 + +modules: + - name: azure-provider + type: iac.provider + config: + provider: azure + subscriptionId: ${AZURE_SUBSCRIPTION_ID} + tenantId: ${AZURE_TENANT_ID} + clientId: ${AZURE_CLIENT_ID} + clientSecret: ${AZURE_CLIENT_SECRET} From 31d942b3c177480810a0c37e6b4952ab684a9c39 Mon Sep 17 00:00:00 2001 From: Jon Langevin Date: Tue, 19 May 2026 11:25:05 -0400 Subject: [PATCH 2/2] fix(azure): correct latest version tag in README install snippet v1.2.1 is the latest released tag; v2.0.0 was incorrect. Part of 2026-05-19 multi-repo OSS-readiness QoL sweep. See: https://github.com/GoCodeAlone/workflow/pull/714 Co-Authored-By: Claude Opus 4.7 (1M context) --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 66033df..5331c6a 100644 --- a/README.md +++ b/README.md @@ -22,7 +22,7 @@ Azure provider plugin for workflow IaC — manages ACI, AKS, SQL, Redis, VNet, L version: 1 plugins: - name: workflow-plugin-azure - version: v2.0.0 + version: v1.2.1 source: github.com/GoCodeAlone/workflow-plugin-azure ```