Skip to content

AGENTS.md

Latest commit

 

History

History
46 lines (31 loc) · 1.56 KB

AGENTS.md

File metadata and controls

46 lines (31 loc) · 1.56 KB
Raw

Agent Instructions

Repository Purpose

OpenTofu root module for GitHub organization infrastructure.

Git Workflow

Use a feature branch and open a pull request rather than pushing directly to main. A push to main can invoke apply after tests pass and configured environment gates approve it. Do not push any branch unless explicitly requested.

Pre-commit Configuration

Pre-commit configuration is centralized at https://raw.githubusercontent.com/makeitworkcloud/images/main/tfroot-runner/pre-commit-config.yaml. The root .pre-commit-config.yaml is generated and ignored; do not edit it.

For local development, run:

make test

This refreshes the generated config from the canonical source on every run and replaces it only when the content changed.

CI/CD

This repo uses the shared opentofu.yml workflow from shared-workflows. Jobs run natively on arc-tf; the runner pod already uses the tfroot-runner image, so the workflow does not start a nested container. The shared workflow fetches the canonical pre-commit config at runtime; this repository does not provide a tracked copy.

Failure Modes

"manifest unknown" error: The tfroot-runner:latest image doesn't exist in GHCR. Check if the images repo Build workflow succeeded.

Pre-commit failures: If hooks fail unexpectedly, the canonical config may have changed. Re-run make test to refresh it and run the checks.

Related Repositories

  • images - Contains tfroot-runner image and canonical pre-commit config
  • shared-workflows - Contains the reusable OpenTofu workflow