Skip to content

docs: add missing AGENTS.md (and README where missing) #207

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
trly wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: add missing AGENTS.md (and README where missing) #207

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
54 changes: 54 additions & 0 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
# AGENTS.md

Terraform module for provisioning Sourcegraph executors on AWS. This is
infrastructure-as-code (HCL), not an application — there is no app to run.

## Layout

- `main.tf`, `variables.tf`, `providers.tf` — root module wiring the submodules together.
- `modules/` — the submodules: `networking`, `docker-mirror`, `executors`, `credentials`.
- `examples/` — usable configurations: `single-executor`, `private-single-executor`, `multiple-executors`.
- `iam-policy.json` — example minimal IAM policy for deploy/destroy.
- `.buildkite/` — CI scripts (the source of truth for the commands below).

## Toolchain

Tool versions are pinned in `.tool-versions` (managed via mise or asdf):
Terraform `1.10.4`, `shfmt` `3.2.0`, `shellcheck` `0.10.0`, `github-cli` `2.65.0`.
The root module requires Terraform `>= 1.1.0, < 2.0.0` and the AWS provider
`>= 3.0, < 5.0.0` (see `providers.tf`).

## Commands

Run these from the repository root; they mirror the Buildkite pipeline.

```bash
# Format HCL (CI checks with -check)
terraform fmt -recursive .

# Validate every module and example (matches .buildkite/terraform-validate.sh).
# Requires AWS_DEFAULT_REGION to be set, e.g. us-east-2.
.buildkite/terraform-validate.sh

# Shell script formatting and linting
.buildkite/shfmt.sh # shfmt -i 2 -ci -d .
.buildkite/shellcheck.sh # shellcheck across all *.sh

# Security scan (soft-fail in CI)
.buildkite/ci-checkov.sh # installs and runs checkov
```

To validate a single module manually:

```bash
cd modules/executors
terraform init
terraform validate .
```

## Conventions

- Keep all HCL `terraform fmt`-clean and shell scripts `shfmt -i 2 -ci` / `shellcheck`-clean before committing.
- The module's major and minor version must match the target Sourcegraph version; keep changes consistent across the root module and all submodules.
- `.editorconfig` defines whitespace rules — respect it.
- Do not delete `.use_mise`; CI uses it to choose mise vs. asdf for tool installation.