Skip to content

docs: refresh docs #105

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

Merged
joshuarli merged 1 commit into from
Oct 17, 2026
Merged

docs: refresh docs #105

Show file tree
Hide file tree
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
21 changes: 21 additions & 0 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# AGENTS.md

Jsonnet libraries in `libs/` that generate GoCD pipelines for getsentry services. Consumers install `libs/` with jsonnet-bundler.

## Commands

- `npm install`: install the test and lint dependencies.
- `make`: format with `jsonnetfmt`, lint with `jsonnet-lint`, and run the ava tests. Needs go-jsonnet on `PATH`.
- `npm run lint`: eslint and prettier checks. CI runs it, `make` does not.

## Invariants

- Rendered output must match the goldens in `test/testdata/goldens/` byte for byte.
- `libs/bash/` scripts are embedded in rendered pipelines. Editing them changes the rollback goldens.
- Pipeline names (`deploy-<name>`, `deploy-<name>-<group>`, `rollback-<name>`) are the GoCD identity of every consumer's pipelines. Renaming one replaces those pipelines.

## Docs

- Library usage and `render()` configuration: [README.md](README.md)
- Tests, goldens, and testing on GoCD: [docs/testing.md](docs/testing.md)
- Releases and rollout to services: [docs/releasing.md](docs/releasing.md)
Loading
Loading