Skip to content

feat: add weekly sbx/gVisor documentation updater workflow - #6333

Merged
lpcox merged 2 commits into
mainfrom
workflow-sbx-gvisor-doc-updater
Jul 17, 2026
Merged

feat: add weekly sbx/gVisor documentation updater workflow#6333
lpcox merged 2 commits into
mainfrom
workflow-sbx-gvisor-doc-updater

Conversation

@lpcox

@lpcox lpcox commented Jul 17, 2026

Copy link
Copy Markdown
Collaborator

What

Adds a scheduled agentic workflow, sbx-gvisor-doc-updater, that keeps the two integration docs accurate:

  • docs/sbx-integration.md (Docker Sandboxes / sbx)
  • docs/gvisor-integration.md (gVisor / runsc)

How it works

  • Schedule: weekly (fuzzy-scattered to 21 2 * * 1) plus workflow_dispatch. A skip-if-match guard avoids stacking a second open PR.
  • Inputs it reconciles against:
    1. Upstream docs via web-fetch — the current Docker Sandboxes pages (docs.docker.com/ai/sandboxes/*) and gVisor architecture pages (gvisor.dev/docs/architecture_guide/*).
    2. Repo implementation — reads the source files the docs cite (container-runtime.ts, sbx-manager.ts, main-action.ts, agent-service.ts, topology.ts, etc.) and reviews changes merged in the last 7 days via git log.
  • Output: a single create-pull-request restricted to the two docs (allowed-files), or noop when both are already accurate. The agent job is read-only; all writes go through safe outputs.

Security / scope

  • Agent job permissions: contents: read, pull-requests: read, copilot-requests: write — no direct write scopes.
  • bash is restricted to read-only git/inspection commands; edit limited in effect by the allowed-files PR contract.
  • Network allowlist: defaults, github, docs.docker.com, gvisor.dev, *.gvisor.dev. (The compiler suggests the containers ecosystem for docs.docker.com, but that ecosystem covers image registries, not the docs site — the explicit FQDN is required.)

Notes

  • Compiled with gh aw v0.82.12 (the latest pre-release); the generated .lock.yml is included.
  • markdownlint passes on the workflow source.

Adds an agentic workflow that runs weekly (and on demand) to keep
docs/sbx-integration.md and docs/gvisor-integration.md accurate. It
fetches the latest upstream Docker Sandboxes and gVisor documentation,
reviews repo source changes from the last 7 days, and opens a single
PR (restricted to the two docs) with any corrections, or noops.

Compiled with gh aw v0.82.12 (latest pre-release).

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Copilot-Session: 23717692-af7a-4e03-a156-5b696c3f01bd
Copilot AI review requested due to automatic review settings July 17, 2026 20:23
@github-actions

Copy link
Copy Markdown
Contributor

✅ Coverage Check Passed

Overall Coverage

Metric Base PR Delta
Lines 99.01% 99.04% 📈 +0.03%
Statements 98.95% 98.98% 📈 +0.03%
Functions 99.35% 99.35% ➡️ +0.00%
Branches 95.17% 95.17% ➡️ +0.00%
📁 Per-file Coverage Changes (1 files)
File Lines (Before → After) Statements (Before → After)
src/log-directory-setup.ts 96.2% → 100.0% (+3.78%) 96.3% → 100.0% (+3.71%)

Coverage comparison generated by scripts/ci/compare-coverage.ts

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds a weekly agentic workflow to reconcile sbx and gVisor integration documentation with upstream sources and repository changes.

Changes:

  • Adds scheduled and manual documentation review.
  • Restricts PR output to two integration docs.
  • Includes the compiled workflow lock file.
Show a summary per file
File Description
.github/workflows/sbx-gvisor-doc-updater.md Defines the updater’s configuration and instructions.
.github/workflows/sbx-gvisor-doc-updater.lock.yml Contains the generated GitHub Actions workflow.

Review details

Tip

Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

  • Files reviewed: 2/2 changed files
  • Comments generated: 2
  • Review effort level: Medium

Comment on lines +447 to +450
- name: Checkout repository
uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0
with:
persist-credentials: false

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed in 8ad027d: added a source-level steps: hook that runs git fetch --prune --unshallow before agent execution (mirroring doc-maintainer.md), so the prompt's git log --since="7 days ago" sees the full window. Recompiled the lock file.

Also review changes merged in the **last 7 days** that touch these areas, so the docs reflect recent work:

```bash
git log --since="7 days ago" --oneline -- src/container-runtime.ts src/sbx-manager.ts src/commands/main-action.ts src/services/agent-service.ts src/topology.ts

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed in 8ad027d: the recent-change scan now includes src/services/agent-environment/tool-specific-environment.ts and src/commands/validators/security-mode.ts.

- Add a source-level unshallow step so the agent's 'git log --since=
  "7 days ago"' can inspect the full 7-day window rather than only the
  tip commit (actions/checkout defaults to depth 1).
- Include src/services/agent-environment/tool-specific-environment.ts
  and src/commands/validators/security-mode.ts in the recent-change
  scan, since both are key files cited by the target docs.

Recompiled with gh aw v0.82.12 (latest pre-release); npm test passes.

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Copilot-Session: 23717692-af7a-4e03-a156-5b696c3f01bd
@github-actions

Copy link
Copy Markdown
Contributor

✅ Copilot review passed with no inline comments.

@lpcox Add the ready-for-aw label to this PR to trigger agentic CI smoke tests.

@lpcox
lpcox merged commit 4ddbf1a into main Jul 17, 2026
26 checks passed
@lpcox
lpcox deleted the workflow-sbx-gvisor-doc-updater branch July 17, 2026 22:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants