Skip to content

docs: add api-proxy image publishing details to release guide #954

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
Mossaka merged 2 commits into from
Feb 18, 2026
Merged

docs: add api-proxy image publishing details to release guide #954

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
22ad3b1
Initial plan
Copilot Feb 17, 2026
b010ed6
docs: add api-proxy image notes to release guide
Copilot Feb 17, 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
5 changes: 4 additions & 1 deletion docs/releasing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,7 @@ Once the workflow completes:
4. Verify Docker images are published:
- `squid:<version>` and `squid:latest`
- `agent:<version>` and `agent:latest`
- `api-proxy:<version>` and `api-proxy:latest`
- `agent-act:<version>` and `agent-act:latest` (GitHub Actions parity image)

## Manual Release
Expand All @@ -91,6 +92,7 @@ Each release includes:
Docker images are published to `ghcr.io/github/gh-aw-firewall`:
- `squid:<version>` and `squid:latest` - Squid proxy container
- `agent:<version>` and `agent:latest` - Agent execution environment (minimal, ~200MB)
- `api-proxy:<version>` and `api-proxy:latest` - API proxy sidecar for credential isolation
- `agent-act:<version>` and `agent-act:latest` - Agent with GitHub Actions parity (~2GB)

These images are automatically pulled by the CLI when running commands.
Expand Down Expand Up @@ -124,6 +126,7 @@ pkg . --targets node18-linux-x64 --output release/awf
# Build images locally
docker build -t awf-test/squid:local ./containers/squid
docker build -t awf-test/agent:local ./containers/agent
docker build -t awf-test/api-proxy:local ./containers/api-proxy

# Test with local images
sudo ./dist/cli.js \
Expand Down Expand Up @@ -165,7 +168,7 @@ If users report that Docker images can't be pulled:

To make packages public:
1. Go to repository **Packages** page
2. Click on the package (squid or agent)
2. Click on the package (squid, agent, api-proxy, or agent-act)
3. Go to **Package settings**
4. Change visibility to **Public**

Expand Down
Loading