Skip to content

[docs] Update glossary - daily scan 2026-06-30 - #42466

Merged
pelikhan merged 1 commit into
mainfrom
docs/glossary-daily-2026-06-30-ccdb442c86ed185e
Jun 30, 2026
Merged

[docs] Update glossary - daily scan 2026-06-30#42466
pelikhan merged 1 commit into
mainfrom
docs/glossary-daily-2026-06-30-ccdb442c86ed185e

Conversation

@github-actions

@github-actions github-actions Bot commented Jun 30, 2026

Copy link
Copy Markdown
Contributor

Summary

Adds a new glossary entry for sandbox.agent.sudo documenting the AWF privilege model and deprecation of the sudo: true option.

Changes

File Type Description
docs/src/content/docs/reference/glossary.md docs New entry: sandbox.agent.sudo

Details

New glossary entry: sandbox.agent.sudo

Documents the sandbox.agent.sudo field:

  • Default: false — AWF runs rootless with --network-isolation for container-boundary egress control without requiring host-level sudo.
  • sudo: false (default): AWF enforces network egress at the container level; the secure default for all workflows.
  • sudo: true (deprecated): AWF runs as sudo -E awf, granting host-level iptables control. Emits a compile-time warning in non-strict mode and an error in Strict Mode.

Includes a code example and cross-references to the Sandbox Configuration page and Strict Mode glossary entry.

Deprecations

  • sandbox.agent.sudo: true — documented as deprecated; use the default rootless mode (sudo: false) instead.

Scope

  • Type: docs
  • Breaking: No
  • Tests required: No

Generated by PR Description Updater for #42466 · 27.9 AIC · ⌖ 6.8 AIC · ⊞ 4.7K ·

Added sandbox.agent.sudo glossary entry documenting the field's behavior
and new default (false = network isolation mode), introduced by PR #42354
which changed the default from sudo mode to rootless/network-isolation mode.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@github-actions

Copy link
Copy Markdown
Contributor Author

Hey @github-actions[bot] 👋 — nice addition of the sandbox.agent.sudo glossary entry! The definition is clear, the sudo: false / sudo: true distinction is well-articulated, and the inline code example rounds it out nicely.

One small thing worth checking:

  • Documentation tests — no test files were changed alongside the glossary edit. If the project has glossary validation scripts (e.g., alphabetical-order checks, anchor uniqueness, or broken-link detection against docs/), running them against this change would give reviewers extra confidence.

If you would like a hand, you can assign this prompt to your coding agent:

Check whether the github/gh-aw repository has any documentation validation scripts (e.g. in scripts/, Makefile targets, or CI steps) that cover docs/src/content/docs/reference/glossary.md. If found, run them locally and fix any failures caused by the new `sandbox.agent.sudo` entry added in this PR. Also verify the new entry is correctly placed in alphabetical order relative to its neighbours.

Generated by ✅ Contribution Check · 140.1 AIC · ⌖ 19.4 AIC · ⊞ 6.3K ·

@pelikhan
pelikhan merged commit 2a92f87 into main Jun 30, 2026
@pelikhan
pelikhan deleted the docs/glossary-daily-2026-06-30-ccdb442c86ed185e branch June 30, 2026 14:06
@github-actions

Copy link
Copy Markdown
Contributor Author

🎉 This pull request is included in a new release.

Release: v0.82.1

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation glossary

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant