Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
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
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
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