docs(gcp): add README + examples + experimental banner (QoL sweep)#16
Merged
Conversation
- Adds README.md with experimental banner, module-types table, install instructions, and required env vars (GOOGLE_APPLICATION_CREDENTIALS, GCP_PROJECT). - 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) <noreply@anthropic.com>
There was a problem hiding this comment.
Pull request overview
This PR adds standard repository documentation and GitHub templates to improve onboarding and contribution flow for the workflow-plugin-gcp plugin.
Changes:
- Add a top-level
README.mddescribing plugin capabilities, install instructions, and a minimal example. - Add
CONTRIBUTING.mdplus GitHub PR/issue templates for consistent project hygiene. - Add
examples/minimal/config.yamlintended as a validating minimal configuration.
Reviewed changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| README.md | Introduces plugin overview, install snippet, and links; currently overstates supported services and implies env vars are required. |
| examples/minimal/config.yaml | Adds a minimal config example; currently does not match the plugin’s actual module/provider config contracts. |
| CONTRIBUTING.md | Adds contribution guidelines and local dev commands. |
| .github/PULL_REQUEST_TEMPLATE.md | Adds a PR template with test/checklist prompts. |
| .github/ISSUE_TEMPLATE/feature_request.md | Adds a feature request issue template. |
| .github/ISSUE_TEMPLATE/bug_report.md | Adds a bug report issue template. |
Comments suppressed due to low confidence (1)
examples/minimal/config.yaml:17
- The
iac.providermodule config shown (provider: gcpandcredentials: gcp-credentials) doesn’t correspond to the typed provider config this plugin expects.provider/GCPProvider.Initializerequires at leastproject_id(and optionallyregion,zone,credentials_fileorservice_account_json), and there’s no mechanism to reference agcp.credentialsmodule fromiac.providerconfig.
- name: gcp-provider
type: iac.provider
config:
provider: gcp
credentials: gcp-credentials
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| [](LICENSE) | ||
| [](https://pkg.go.dev/github.com/GoCodeAlone/workflow-plugin-gcp) | ||
|
|
||
| GCP provider plugin for workflow IaC — manages GKE, Cloud SQL, Memorystore, Compute Engine, Cloud Storage, Cloud Pub/Sub, Cloud Functions, Cloud DNS, Cloud Load Balancing, Cloud Armor, Secret Manager, Cloud CDN, and IAM resources. |
|
|
||
| See `examples/minimal/config.yaml`. | ||
|
|
||
| Required env vars: `GOOGLE_APPLICATION_CREDENTIALS`, `GCP_PROJECT`. |
Comment on lines
+10
to
+11
| credentialsFile: ${GOOGLE_APPLICATION_CREDENTIALS} | ||
| project: ${GCP_PROJECT} |
Part of 2026-05-19 multi-repo OSS-readiness QoL sweep. See: GoCodeAlone/workflow#714 Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 6 out of 6 changed files in this pull request and generated 2 comments.
Comments suppressed due to low confidence (1)
examples/minimal/config.yaml:17
- The
iac.providermodule config in this example doesn’t match the plugin’siac.providercontract. The provider expectsproject_id(required) plus optionalregion/zoneand auth viacredentials_fileorservice_account_json(seeprovider/provider.goandplugin.contracts.json), notprovider: gcporcredentials: <module>. As written, this config is unlikely to work under strict contract validation—please update the example to use the correct fields.
- name: gcp-provider
type: iac.provider
config:
provider: gcp
credentials: gcp-credentials
Comment on lines
+10
to
+11
| credentialsFile: ${GOOGLE_APPLICATION_CREDENTIALS} | ||
| project: ${GCP_PROJECT} |
Comment on lines
+40
to
+41
| Required env vars: `GOOGLE_APPLICATION_CREDENTIALS`, `GCP_PROJECT`. | ||
|
|
- README: replace invented service list with actual Capabilities() resource types (Cloud Run, GKE, Cloud SQL, Memorystore, VPC, LB, DNS, Artifact Registry, API Gateway, Firewall, IAM, GCS, SSL certs). - README: rework env-vars note to clarify ADC is the default; GOOGLE_APPLICATION_CREDENTIALS is optional. - examples/minimal/config.yaml: fix gcp.credentials keys (credentialsFile/project → projectId per CreateModule source); fix iac.provider keys (project_id per Initialize source). Part of 2026-05-19 multi-repo OSS-readiness QoL sweep. See: GoCodeAlone/workflow#714 Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Adds an [Unreleased] section documenting the README, CONTRIBUTING, example config, and .github templates added by this QoL sweep PR. Also normalises the format header from "loosely based on" to the canonical Keep-a-Changelog phrasing. Part of 2026-05-19 multi-repo OSS-readiness QoL sweep. See: GoCodeAlone/workflow#714 Co-Authored-By: Claude Opus 4.7 (1M context) <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.mdwith experimental banner, module types (iac.provider,gcp.credentials,storage.gcs), install snippet, required env vars (GOOGLE_APPLICATION_CREDENTIALS,GCP_PROJECT), and links to upstream docs.CONTRIBUTING.mdfrom shared plugin template.examples/minimal/config.yaml(passeswfctl validate --skip-unknown-types)..github/PULL_REQUEST_TEMPLATE.mdand.github/ISSUE_TEMPLATE/(bug report + feature request).References
workflow/docs/plans/2026-05-19-multi-repo-qol-sweep.mdTask 12 (P1 plugin docs sweep)workflow/docs/plans/2026-05-19-multi-repo-qol-sweep-design.mdTest plan
go build ./...passesgo vet ./...passeswfctl validate --skip-unknown-types examples/minimal/config.yamlpasses (2 modules, 0 workflows, 0 triggers)🤖 Generated with Claude Code