Skip to content

Add governance guide for gh aw env defaults and scope inheritance#41758

Merged
pelikhan merged 5 commits into
mainfrom
copilot/create-governance-documentation-page
Jun 26, 2026
Merged

Add governance guide for gh aw env defaults and scope inheritance#41758
pelikhan merged 5 commits into
mainfrom
copilot/create-governance-documentation-page

Conversation

Copilot AI commented Jun 26, 2026

Copy link
Copy Markdown
Contributor

This PR adds dedicated governance documentation for environment defaults in gh-aw, focused on how to configure GH_AW_DEFAULT_* values with gh aw env and how scope inheritance works across enterprise, organization, and repository levels. It closes the gap between variable reference docs and operational rollout guidance for multi-repo governance.

  • New guide: environment governance

    • Added docs/src/content/docs/guides/governance.md.
    • Documents:
      • gh aw env get / gh aw env update workflows
      • default_* YAML schema and deletion semantics (null)
      • rollout model (enterprise baseline → org policy → repo exceptions)
      • precedence/percolation behavior and frontmatter override rules
      • compile-time vs runtime default resolution
  • Navigation updates

    • Added Governance under Guides in docs/astro.config.mjs for discoverability.
  • Cross-reference improvements

    • Linked the new guide from reference/environment-variables.md in Related Documentation.
  • Representative snippet

    default_max_ai_credits: "5M"
    default_max_daily_ai_credits: "15M"
    default_max_turns: "12"
    default_timeout_minutes: "30"
    default_model_copilot: "gpt-5-mini"
    default_model_claude: "claude-haiku-4-5"
    default_model_codex: "gpt-5.4-mini"
    default_detection_model: "gpt-5.5-mini"
    default_utc: "-08:00" # UTC offset for rendered CLI timestamps

Copilot AI and others added 3 commits June 26, 2026 14:38
Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
@pelikhan pelikhan marked this pull request as ready for review June 26, 2026 17:03
Copilot AI review requested due to automatic review settings June 26, 2026 17:03
@pelikhan pelikhan merged commit 20b3bf6 into main Jun 26, 2026
1 check passed
@pelikhan pelikhan deleted the copilot/create-governance-documentation-page branch June 26, 2026 17:03

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 governance-focused guide to help operators roll out gh aw env (GH_AW_DEFAULT_*) defaults across enterprise/org/repo scopes, and wires it into the docs navigation and related references.

Changes:

  • Added a new guide documenting gh aw env get/update, scope inheritance, precedence, and compile-time vs runtime default resolution.
  • Added “Governance” to the Guides sidebar for discoverability.
  • Linked the new guide from the environment variables reference page.
Show a summary per file
File Description
docs/src/content/docs/guides/governance.md New governance guide describing defaults management, precedence, and rollout patterns.
docs/src/content/docs/reference/environment-variables.md Adds cross-link to the governance guide in Related Documentation.
docs/astro.config.mjs Adds “Governance” entry under Guides in the sidebar.

Review details

Tip

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

  • Files reviewed: 3/3 changed files
  • Comments generated: 3
  • Review effort level: Low

Comment on lines +39 to +41
> [!NOTE]
> Set a key to `null` (or omit it) to delete that variable
> from the selected scope during `gh aw env update`.
Comment on lines +131 to +134
- use non-zero integers for
`default_max_ai_credits`,
`default_max_daily_ai_credits`,
`default_detection_max_ai_credits`
Comment on lines +28 to +29
default_max_ai_credits: "5M"
default_max_daily_ai_credits: "15M"
github-actions Bot added a commit that referenced this pull request Jun 29, 2026
Add two new glossary entries from weekly scan:

- `gh aw env`: CLI command for managing GH_AW_DEFAULT_* variables at
  enterprise, org, and repo scope. Added to Development and Compilation
  section, based on the governance guide introduced in #41758.

- `GH_AW_POLICY_*`: Runtime Policy Variables family that enforce
  capability gates without recompiling workflows (e.g.,
  GH_AW_POLICY_ALLOW_CREATE_PULL_REQUEST). Added near GH_AW_DEFAULT_*
  in Advanced Features section, based on #41771.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
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.

3 participants