Merge pull request #27 from dash14/docs/update-assets

Update docs, examples, and assets for v2

Author: dash14

.github/workflows/example-audit.yml

@@ -11,16 +11,15 @@ jobs:
 
     steps:
       - name: Start Buildcage builder
-        id: buildcage
-        uses: dash14/buildcage/setup@v1
+        uses: dash14/buildcage/setup@v2
         with:
           proxy_mode: audit
 
       - name: Set up Docker Buildx
-        uses: docker/setup-buildx-action@v3
+        uses: docker/setup-buildx-action@v4
         with:
           driver: remote
-          endpoint: tcp://localhost:${{ steps.buildcage.outputs.port }}
+          endpoint: docker-container://buildcage
 
       - name: Create test Dockerfile
         run: |
@@ -43,4 +42,4 @@ jobs:
 
       - name: Show proxy report
         if: always()
-        uses: dash14/buildcage/report@v1
+        uses: dash14/buildcage/report@v2

.github/workflows/example-restrict.yml

@@ -11,19 +11,18 @@ jobs:
 
     steps:
       - name: Start Buildcage builder
-        id: buildcage
-        uses: dash14/buildcage/setup@v1
+        uses: dash14/buildcage/setup@v2
         with:
           proxy_mode: restrict
           allowed_https_rules: >-
             registry.npmjs.org:443
             fonts.googleapis.com:443
 
       - name: Set up Docker Buildx
-        uses: docker/setup-buildx-action@v3
+        uses: docker/setup-buildx-action@v4
         with:
           driver: remote
-          endpoint: tcp://localhost:${{ steps.buildcage.outputs.port }}
+          endpoint: docker-container://buildcage
 
       - name: Create test Dockerfile
         run: |
@@ -47,6 +46,6 @@ jobs:
 
       - name: Show proxy report
         if: always()
-        uses: dash14/buildcage/report@v1
+        uses: dash14/buildcage/report@v2
         with:
           fail_on_blocked: false

README.md

@@ -91,12 +91,12 @@ jobs:
 
       - name: Start Buildcage in audit mode
         id: buildcage
-        uses: dash14/buildcage/setup@v1
+        uses: dash14/buildcage/setup@v2
         with:
           proxy_mode: audit  # Log everything, block nothing
 
       - name: Set up Docker Buildx
-        uses: docker/setup-buildx-action@v3
+        uses: docker/setup-buildx-action@v4
         with:
           driver: remote
           endpoint: docker-container://buildcage
@@ -109,7 +109,7 @@ jobs:
 
       - name: Show Buildcage report
         if: always()
-        uses: dash14/buildcage/report@v1
+        uses: dash14/buildcage/report@v2
         with:
           fail_on_blocked: false  # Don't fail, just show the report
 ```
@@ -139,15 +139,15 @@ jobs:
 
       - name: Start Buildcage in restrict mode
         id: buildcage
-        uses: dash14/buildcage/setup@v1
+        uses: dash14/buildcage/setup@v2
         with:
           proxy_mode: restrict  # Block everything except allowed domains
           allowed_https_rules: >-
             registry.npmjs.org:443
             fonts.googleapis.com:443
 
       - name: Set up Docker Buildx
-        uses: docker/setup-buildx-action@v3
+        uses: docker/setup-buildx-action@v4
         with:
           driver: remote
           endpoint: docker-container://buildcage
@@ -160,7 +160,7 @@ jobs:
 
       - name: Show Buildcage report
         if: always()
-        uses: dash14/buildcage/report@v1
+        uses: dash14/buildcage/report@v2
         # Build fails if any unexpected connections were blocked
 ```
 
@@ -177,7 +177,7 @@ Starts the Buildcage builder container.
 ```yaml
 - name: Start Buildcage builder
   id: buildcage
-  uses: dash14/buildcage/setup@v1
+  uses: dash14/buildcage/setup@v2
   with:
     proxy_mode: restrict
     allowed_https_rules: registry.npmjs.org:443 github.com:443
@@ -216,7 +216,7 @@ Pass the container name to [`docker/setup-buildx-action`](https://github.com/doc
 
 ```yaml
 - name: Set up Docker Buildx
-  uses: docker/setup-buildx-action@v3
+  uses: docker/setup-buildx-action@v4
   with:
     driver: remote
     endpoint: docker-container://buildcage
@@ -261,7 +261,7 @@ Displays communication logs after builds and optionally fails if any BLOCKED con
 ```yaml
 - name: Show proxy report
   if: always()
-  uses: dash14/buildcage/report@v1
+  uses: dash14/buildcage/report@v2
 ```
 
 #### Job Summary

assets/diagram-architecture.png

@@ -91,12 +91,12 @@ Fields: `[timestamp] buildcage [status] "domain:port" reason`
 ```
 .
 ├── setup/                       # GitHub Actions setup
-│   ├── action.yml               # GitHub Action: dash14/buildcage/setup@v1
+│   ├── action.yml               # GitHub Action: dash14/buildcage/setup@v2
 │   ├── compose.yml              # Compose config for GitHub Actions (with image tag)
 │   ├── main.mjs                 # Setup entrypoint (rule generation, compose up)
 │   └── post.mjs                 # Post-action cleanup
 ├── report/                      # GitHub Actions report
-│   ├── action.yml               # GitHub Action: dash14/buildcage/report@v1
+│   ├── action.yml               # GitHub Action: dash14/buildcage/report@v2
 │   └── main.mjs                 # Log analysis and Job Summary output
 ├── docker/
 │   ├── Dockerfile               # Multi-stage BuildKit + haproxy + dnsmasq + s6-overlay

assets/diagram-overview.png

@@ -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@v1
+  uses: dash14/buildcage/setup@v2
   with:
     proxy_mode: restrict
 

assets/report-audit-mode.png

@@ -79,13 +79,13 @@ jobs:
 
       - name: Start Buildcage
         id: buildcage
-        uses: <your_org>/buildcage/setup@v1
+        uses: <your_org>/buildcage/setup@v2
         with:
           proxy_mode: audit
       # ... rest of your workflow
 ```
 
-Note that `uses:` now points to `<your_org>/buildcage/setup@v1` instead of `dash14/buildcage/setup@v1`. The same applies to the report action (`<your_org>/buildcage/report@v1`).
+Note that `uses:` now points to `<your_org>/buildcage/setup@v2` instead of `dash14/buildcage/setup@v2`. The same applies to the report action (`<your_org>/buildcage/report@v2`).
 
 ## Syncing with Upstream
 

docs/development.md

@@ -28,7 +28,7 @@ export function buildRestrictExample(auditedRows, actionRepo) {
   // Build YAML lines
   let yaml = "";
   yaml += "- name: Start Buildcage in restrict mode\n";
-  yaml += `  uses: ${actionRepo}/setup@v1\n`;
+  yaml += `  uses: ${actionRepo}/setup@v2\n`;
   yaml += "  with:\n";
   yaml += "    proxy_mode: restrict\n";
   for (const [param, rules] of groups) {