docs: AGENTS.md, server quick-start, and PR CI workflow - #10
Merged
Merged
Conversation
- AGENTS.md: agent working rules (mise toolchain, layout, conventions, testing, pre-commit checks). CLAUDE.md symlinks to it. - docs/running-on-servers.md: operator runbook (config, clustering, auth/TLS, run, verify, observability); notes compile-time config and deferred mix release / runtime.exs. - .github/workflows/ci.yml: PR + push CI — format check, warnings-as-errors compile, hermetic mix test, and distributed peer-node tests (started via a named+cookied VM, since plain mix test can't bootstrap distribution).
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
1 participant
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.
What
First agent-instruction file, server deployment guide, and CI for Brigade.
CLAUDE.mdsymlink) — working rules for AI agents: mise toolchain (alwaysmise exec -- mix),lib/brigade/layout, behaviour-seam / generated-proto conventions, testing rules, pre-commit checks. OmitsCo-Authored-Byper repo convention.min_cluster_sizesplit-brain guard), north/south auth + mTLS, named-node run command, verify (/healthz,/status,/metrics), observability. Flags that config is compile-time today (noruntime.exs, nomix releaseyet).main:erlef/setup-beampinned tomise.toml(Elixir 1.18.4 / OTP 27.3.4.14), deps/_buildcache, then format check → compile--warnings-as-errors→ hermeticmix test→ distributed peer-node tests.Note
Distributed tests need a distributed VM. Plain
mix test --include distributeddies with:nodistribution(thecluster_singleton_testsetup can't bootstrap distribution from a non-distributed VM). CI and the docs run them viaelixir --name ... --cookie ... -S mix test --include distributed.Verified locally
mix format --check-formatted✓mix compile --warnings-as-errors✓mix test— 27 tests, 0 failures ✓