Skip to content

feat: publish versioned JSON Schema for AWF config file #2375

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
lpcox merged 4 commits into from
May 1, 2026
Merged

feat: publish versioned JSON Schema for AWF config file #2375

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
a42c828
Initial plan
Copilot May 1, 2026
b145431
feat: publish versioned JSON Schema for AWF config file
Copilot May 1, 2026
88ae896
fix: use --print in release schema generation step
Copilot May 1, 2026
c42ce40
fix: address schema generator review feedback
Copilot May 1, 2026
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
8 changes: 8 additions & 0 deletions .github/workflows/release.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -520,6 +520,13 @@ jobs:
echo "Generated containers.txt:"
cat release/containers.txt

- name: Generate versioned JSON Schema
run: |
mkdir -p release
node scripts/generate-schema.mjs --version ${{ needs.bump-version.outputs.version }} --print > release/awf-config.schema.json
echo "=== Schema preview (first 10 lines) ==="
head -10 release/awf-config.schema.json

- name: Generate checksums
run: |
cd release
Expand Down Expand Up @@ -645,6 +652,7 @@ jobs:
release/awf-bundle.js
release/awf.tgz
release/containers.txt
release/awf-config.schema.json
release/checksums.txt
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
Expand Down
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ The `--` separator divides firewall options from the command to run.

- [Quick start](docs/quickstart.md) — install, verify, and run your first command
- [Usage guide](docs/usage.md) — CLI flags, domain allowlists, examples
- [AWF config schema](docs/awf-config.schema.json) — machine-readable JSON Schema for JSON/YAML configs
- [AWF config schema](docs/awf-config.schema.json) — machine-readable JSON Schema for JSON/YAML configs (also published as a [versioned release asset](https://github.com/github/gh-aw-firewall/releases/latest/download/awf-config.schema.json) for IDE autocomplete)
- [AWF config spec](docs/awf-config-spec.md) — normative processing and precedence rules for tooling/compiler integration
- [Enterprise configuration](docs/enterprise-configuration.md) — GitHub Enterprise Cloud and Server setup
- [Chroot mode](docs/chroot-mode.md) — use host binaries with network isolation
Expand Down
4 changes: 3 additions & 1 deletion docs/awf-config-spec.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,9 @@ This document defines the canonical configuration model for AWF (`awf`) and is i

The machine-readable schema is published at:

- `docs/awf-config.schema.json`
- `docs/awf-config.schema.json` — live schema (always reflects latest `main`)
- GitHub release asset `awf-config.schema.json` — versioned, stable URL per release
(e.g. `https://github.com/github/gh-aw-firewall/releases/download/v0.23.1/awf-config.schema.json`)

## 1. Conformance

Expand Down
Loading
Loading