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
4 changes: 2 additions & 2 deletions .github/workflows/example-audit.yml
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ jobs:

- name: Start Buildcage builder
# For self-hosting, replace with: <your-org>/buildcage/setup@<SHA>
uses: dash14/buildcage/setup@5852b5758679ec16bf63411118c42850ce86d165 # v2.2.2
uses: dash14/buildcage/setup@39444cc894f62cc065d088f4a07821179d560f5e # v2.2.3
with:
proxy_mode: audit

Expand Down Expand Up @@ -53,4 +53,4 @@ jobs:
- name: Show proxy report
if: always()
# For self-hosting, replace with: <your-org>/buildcage/report@<SHA>
uses: dash14/buildcage/report@5852b5758679ec16bf63411118c42850ce86d165 # v2.2.2
uses: dash14/buildcage/report@39444cc894f62cc065d088f4a07821179d560f5e # v2.2.3
4 changes: 2 additions & 2 deletions .github/workflows/example-explicit.yml
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ jobs:

- name: Start Buildcage builder
# For self-hosting, replace with: <your-org>/buildcage/setup@<SHA>
uses: dash14/buildcage/setup@5852b5758679ec16bf63411118c42850ce86d165 # v2.2.2
uses: dash14/buildcage/setup@39444cc894f62cc065d088f4a07821179d560f5e # v2.2.3
with:
proxy_mode: restrict
proxy_engine: explicit
Expand Down Expand Up @@ -61,6 +61,6 @@ jobs:
- name: Show proxy report
if: always()
# For self-hosting, replace with: <your-org>/buildcage/report@<SHA>
uses: dash14/buildcage/report@5852b5758679ec16bf63411118c42850ce86d165 # v2.2.2
uses: dash14/buildcage/report@39444cc894f62cc065d088f4a07821179d560f5e # v2.2.3
with:
fail_on_blocked: false
4 changes: 2 additions & 2 deletions .github/workflows/example-restrict.yml
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ jobs:

- name: Start Buildcage builder
# For self-hosting, replace with: <your-org>/buildcage/setup@<SHA>
uses: dash14/buildcage/setup@5852b5758679ec16bf63411118c42850ce86d165 # v2.2.2
uses: dash14/buildcage/setup@39444cc894f62cc065d088f4a07821179d560f5e # v2.2.3
with:
proxy_mode: restrict
allowed_https_rules: >-
Expand Down Expand Up @@ -57,6 +57,6 @@ jobs:
- name: Show proxy report
if: always()
# For self-hosting, replace with: <your-org>/buildcage/report@<SHA>
uses: dash14/buildcage/report@5852b5758679ec16bf63411118c42850ce86d165 # v2.2.2
uses: dash14/buildcage/report@39444cc894f62cc065d088f4a07821179d560f5e # v2.2.3
with:
fail_on_blocked: false
2 changes: 1 addition & 1 deletion .github/workflows/example-run-audit.yml
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ jobs:

- name: Discover required domains with the run action
# For self-hosting, replace with: <your-org>/buildcage/run@<SHA>
uses: dash14/buildcage/run@5852b5758679ec16bf63411118c42850ce86d165 # v2.2.2
uses: dash14/buildcage/run@39444cc894f62cc065d088f4a07821179d560f5e # v2.2.3
with:
proxy_mode: audit
# Audit mode allows and logs every connection instead of blocking any
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/example-run.yml
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ jobs:

- name: Run tests with outbound network isolation
# For self-hosting, replace with: <your-org>/buildcage/run@<SHA>
uses: dash14/buildcage/run@5852b5758679ec16bf63411118c42850ce86d165 # v2.2.2
uses: dash14/buildcage/run@39444cc894f62cc065d088f4a07821179d560f5e # v2.2.3
with:
proxy_mode: restrict
allowed_https_rules: >-
Expand Down
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ The walkthrough below covers the full audit → restrict flow.
```yaml
- name: Start Buildcage in audit mode
id: buildcage
uses: dash14/buildcage/setup@5852b5758679ec16bf63411118c42850ce86d165 # v2.2.2
uses: dash14/buildcage/setup@39444cc894f62cc065d088f4a07821179d560f5e # v2.2.3
with:
proxy_mode: audit # Log everything, enforce no allowlist

Expand All @@ -56,7 +56,7 @@ The walkthrough below covers the full audit → restrict flow.

- name: Show Buildcage report
if: always()
uses: dash14/buildcage/report@5852b5758679ec16bf63411118c42850ce86d165 # v2.2.2
uses: dash14/buildcage/report@39444cc894f62cc065d088f4a07821179d560f5e # v2.2.3
with:
fail_on_blocked: false # Don't fail, just show the report
```
Expand All @@ -78,7 +78,7 @@ Copy these domain names into `allowed_https_rules` or `allowed_http_rules` for S
```yaml
- name: Start Buildcage in restrict mode
id: buildcage
uses: dash14/buildcage/setup@5852b5758679ec16bf63411118c42850ce86d165 # v2.2.2
uses: dash14/buildcage/setup@39444cc894f62cc065d088f4a07821179d560f5e # v2.2.3
with:
proxy_mode: restrict # Block everything except allowed domains
allowed_https_rules: >-
Expand All @@ -99,7 +99,7 @@ Copy these domain names into `allowed_https_rules` or `allowed_http_rules` for S

- name: Show Buildcage report
if: always()
uses: dash14/buildcage/report@5852b5758679ec16bf63411118c42850ce86d165 # v2.2.2
uses: dash14/buildcage/report@39444cc894f62cc065d088f4a07821179d560f5e # v2.2.3
# Build fails if any unexpected connections were blocked
```

Expand Down Expand Up @@ -191,7 +191,7 @@ experimental — newer and less battle-tested than the `setup`/`report` actions

```yaml
- name: Run tests with outbound network isolation
uses: dash14/buildcage/run@5852b5758679ec16bf63411118c42850ce86d165 # v2.2.2
uses: dash14/buildcage/run@39444cc894f62cc065d088f4a07821179d560f5e # v2.2.3
with:
proxy_mode: restrict
allowed_https_rules: registry.npmjs.org:443
Expand Down
10 changes: 5 additions & 5 deletions docs/reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Starts the Buildcage builder container.
```yaml
- name: Start Buildcage builder
id: buildcage
uses: dash14/buildcage/setup@5852b5758679ec16bf63411118c42850ce86d165 # v2.2.2
uses: dash14/buildcage/setup@39444cc894f62cc065d088f4a07821179d560f5e # v2.2.3
with:
proxy_mode: restrict
allowed_https_rules: >-
Expand Down Expand Up @@ -164,7 +164,7 @@ Displays communication logs after builds and optionally fails if any BLOCKED con
```yaml
- name: Show proxy report
if: always()
uses: dash14/buildcage/report@5852b5758679ec16bf63411118c42850ce86d165 # v2.2.2
uses: dash14/buildcage/report@39444cc894f62cc065d088f4a07821179d560f5e # v2.2.3
```

### Job Summary
Expand Down Expand Up @@ -203,7 +203,7 @@ build.

```yaml
- name: Run tests with outbound network isolation
uses: dash14/buildcage/run@5852b5758679ec16bf63411118c42850ce86d165 # v2.2.2
uses: dash14/buildcage/run@39444cc894f62cc065d088f4a07821179d560f5e # v2.2.3
with:
proxy_mode: restrict
allowed_https_rules: registry.npmjs.org:443
Expand Down Expand Up @@ -248,7 +248,7 @@ Use the step's own `env:` (not a `with:` input) to pass values into `run` — ex
anything set via `env:` is available there too:

```yaml
- uses: dash14/buildcage/run@5852b5758679ec16bf63411118c42850ce86d165 # v2.2.2
- uses: dash14/buildcage/run@39444cc894f62cc065d088f4a07821179d560f5e # v2.2.3
env:
PR_TITLE: ${{ github.event.pull_request.title }}
with:
Expand Down Expand Up @@ -298,7 +298,7 @@ If `run` needs to write somewhere else — a tool-specific cache directory, for
under `writable`:

```yaml
- uses: dash14/buildcage/run@5852b5758679ec16bf63411118c42850ce86d165 # v2.2.2
- uses: dash14/buildcage/run@39444cc894f62cc065d088f4a07821179d560f5e # v2.2.3
with:
writable: |
/opt/some-tool/cache
Expand Down
2 changes: 1 addition & 1 deletion docs/rules.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ Since the regex is tested against the `domain:port` string, include a port patte

```yaml
- name: Start Buildcage
uses: dash14/buildcage/setup@5852b5758679ec16bf63411118c42850ce86d165 # v2.2.2
uses: dash14/buildcage/setup@39444cc894f62cc065d088f4a07821179d560f5e # v2.2.3
with:
proxy_mode: restrict
Expand Down