OpenParable
Skip to content
← Back to skills

Generate Provider

Development
generate-provider

Generate Provider is an Agent Skill for development published in the GoogleCloudPlatform/magic-modules repository on GitHub: a SKILL.md instruction file an AI agent can load to do this task.

Executes code generation from Magic Modules into downstream Terraform providers and optionally compiles the binary.

View on GitHub ↗
QUICK START

How to use this skill

Bring this guide into your coding agent with a prompt tailored to the tool you use.

  1. Open your project in Codex.
  2. Copy and paste the prompt below.
  3. Review files and risks before approving any action.
Prompt to paste
Inspect the Agent Skill at https://github.com/GoogleCloudPlatform/magic-modules/blob/HEAD/.agents/skills/operations/generate-provider/SKILL.md and all supporting files. Report provenance, permissions, scripts, dependencies, and security risks. Propose an exact installation into .agents/skills/generate-provider, but wait for my approval before writing files or running scripts.

Copying this prompt does not install or run the skill. Review third-party files before use.

generate-provider

Note to AI Agents: You MUST read the YAML frontmatter above first. Only read the rest of this file if the description matches your current roadblock or required task.

Prerequisites

  • You must be in the magic-modules root directory.
  • The $GOPATH environment variable must be set correctly.
  • You must have verified there are no unsaved or uncommitted changes in the downstream provider directory that would be overwritten by code generation.

Execution Steps

Set your variables and run the commands in sequence.

# 1. Define Variables
VERSION="beta" # or "ga"
PROVIDER_PATH="$GOPATH/src/github.com/hashicorp/terraform-provider-google-beta" # or "terraform-provider-google" for GA
MAGIC_MODULES_PATH="$(pwd)"

# Verify no uncommitted changes exist in the downstream provider directory. 
# Stop if there are uncommitted changes and alert the user.
cd "$PROVIDER_PATH"
git status --porcelain

# 2. Code Generation (Run from Magic Modules root)
cd "$MAGIC_MODULES_PATH"
make provider VERSION=$VERSION OUTPUT_PATH="$PROVIDER_PATH"

# 3. Verify Changes (Run from Downstream Provider root)
cd "$PROVIDER_PATH"

# Verify that git status precisely matches the scope of your local Magic Modules edits.
# If you see "surprise" diffs in unrelated resources, ask the user if you should run `sync-provider` first.
git status --porcelain

# 4. Compile Binary (Already in Downstream Provider root)
make build

Handoff & Guardrails

  • Verify successful compilation.
  • CRITICAL SAFEGUARD: Stop here! Do NOT automatically proceed to running tests unless the user explicitly requested you to do so in their initial prompt. If testing was not requested, ask the user for their next steps.