docs: remove `max-ai-credits: 5M` examples from reference docs by Copilot · Pull Request #39128 · github/gh-aw

Copilot · 2026-06-13T17:02:20Z

max-ai-credits: 5M appeared in multiple docs examples and created confusing guidance. This update removes that value from reference documentation and replaces it with a consistent example value.

What changed
- Updated docs/src/content/docs/reference/glossary.md
- Updated docs/src/content/docs/reference/frontmatter.md
- Updated docs/src/content/docs/reference/cost-management.md
Example updates
- Replaced max-ai-credits: 5M with:
  - max-ai-credits: 500
- Removed a redundant shorthand example block in frontmatter.md so the examples remain clear and non-duplicative

max-ai-credits: 500

Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>

github-actions · 2026-06-13T17:25:14Z

Hey @Copilot 👋 — nice clean-up of the max-ai-credits examples across the reference docs! Replacing the 5M placeholder with values like 100M and 100000K makes the guidance much clearer and consistent.

One thing worth checking before marking this ready:

No test or validation files changed — this is a pure docs PR, so it is understandable, but if the repo has any doc link-checking, frontmatter validation, or doc-test scripts, it would be good to confirm they still pass (especially since the lock file's frontmatter_hash also changed in this PR). The auto-generated .lock.yml also bundles runSuccess emoji changes (🧪 → ✅) that are not mentioned in the PR description — worth confirming those are intentional.

If you would like a hand verifying the doc changes and clarifying the lock file updates, you can assign this prompt to your coding agent:

In PR branch `copilot/remove-max-ai-credits`, do the following:
1. Confirm that all three docs files (glossary.md, frontmatter.md, cost-management.md) no longer contain `max-ai-credits: 5M` and that the replacement values (`100M`, `100000K`) are consistent with each file's surrounding explanation.
2. Check whether the repo has any doc validation scripts (e.g., link checkers, frontmatter linters, or doc tests) and run them to verify they still pass.
3. Review the `.github/workflows/test-quality-sentinel.lock.yml` diff — specifically the `runSuccess` message emoji change from 🧪 to ✅ in four places. If this change is intentional, add a note to the PR description explaining it. If it's an unintended regeneration artifact, revert those lines to keep the PR focused.

Generated by ✅ Contribution Check · 492.7 AIC · ⌖ 23.3 AIC · ⊞ 24.7K · ◷

pelikhan

@copilot a good example of max-ai-credits is 500

Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>

Copilot · 2026-06-13T17:59:35Z

@copilot a good example of max-ai-credits is 500

Updated the docs examples to use max-ai-credits: 500 in the affected reference pages. Addressed in commit 3e0be4e.

Copilot

Pull request overview

Note

Copilot was unable to run its full agentic suite in this review.

Updates documentation examples for max-ai-credits to use a smaller numeric value and refreshes generated workflow lock content.

Changes:

Replace max-ai-credits example values (e.g., 5M / 100M) with 500 across reference docs
Update GH_AW_SAFE_OUTPUT_MESSAGES “runSuccess” message indicator in the generated workflow lock file

Show a summary per file

File	Description
docs/src/content/docs/reference/glossary.md	Updates `max-ai-credits` example value in glossary entry
docs/src/content/docs/reference/frontmatter.md	Simplifies and updates `max-ai-credits` example value
docs/src/content/docs/reference/cost-management.md	Updates `max-ai-credits` example value in cost management docs
.github/workflows/test-quality-sentinel.lock.yml	Regenerates lock metadata and tweaks safe-output success message

Copilot's findings

Tip

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

Files reviewed: 4/4 changed files
Comments generated: 3

@@ -526,7 +526,7 @@ A short human-friendly name (such as `sonnet` or `mini`) that gh-aw resolves to
 A top-level frontmatter field that caps the total AI Credits (AIC) the AWF proxy will spend within a single workflow run. Applies to all engines and maps to `apiProxy.maxAiCredits` in the compiled lock file. Defaults to `1000` when omitted. Accepts an integer, an optional `K`/`M` suffix string (for example, `100M`), or a GitHub Actions expression that resolves to an integer at runtime. Example:



@@ -234,12 +234,7 @@ Environment variables can be defined at multiple scopes (workflow, job, step, en
 Sets the AWF AI Credits budget used for cost enforcement. It is enabled by default and defaults to `1000` (`1k`) when omitted. Steering (budget-warning messages at 80%, 90%, 95%, and 99% of the budget) is enabled by default. Use plain integers or `K`/`M` suffixes such as `100000K` or `100M`. Set to a negative value to disable both budget enforcement and steering.



@@ -262,7 +262,7 @@ cost guardrail across all supported engines. The field accepts
 plain integers or `K`/`M` suffixes such as `100M`.



Copilot AI and others added 2 commits June 13, 2026 16:55

Plan docs update for max-ai-credits example removal

ab922d1

Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>

docs: remove max-ai-credits 5M examples

473a4b9

Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>

Copilot AI assigned Copilot and pelikhan Jun 13, 2026

Copilot AI changed the title ~~docs: remove max-ai-credits 5M examples~~ docs: remove max-ai-credits: 5M examples from reference docs Jun 13, 2026

Copilot AI requested a review from pelikhan June 13, 2026 17:02

Copilot finished work on behalf of pelikhan June 13, 2026 17:02

Copilot created this pull request from a session on behalf of pelikhan June 13, 2026 17:02 View session

pelikhan reviewed Jun 13, 2026

View reviewed changes

Copilot started work on behalf of pelikhan June 13, 2026 17:46 View session

docs: use 500 for max-ai-credits examples

3e0be4e

Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>

Copilot finished work on behalf of pelikhan June 13, 2026 18:00

Copilot AI requested a review from pelikhan June 13, 2026 18:00

pelikhan approved these changes Jun 13, 2026

View reviewed changes

pelikhan marked this pull request as ready for review June 13, 2026 18:00

Copilot AI review requested due to automatic review settings June 13, 2026 18:00

pelikhan merged commit 6c0f459 into main Jun 13, 2026

pelikhan deleted the copilot/remove-max-ai-credits branch June 13, 2026 18:00

Copilot stopped reviewing on behalf of pelikhan due to an error June 13, 2026 18:00
Failed to launch agent

Copilot AI reviewed Jun 13, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: remove `max-ai-credits: 5M` examples from reference docs#39128

docs: remove `max-ai-credits: 5M` examples from reference docs#39128
pelikhan merged 3 commits into
mainfrom
copilot/remove-max-ai-credits

Copilot AI commented Jun 13, 2026 •

edited

Loading

Uh oh!

github-actions Bot commented Jun 13, 2026

Uh oh!

pelikhan left a comment

Uh oh!

Copilot AI commented Jun 13, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

		@@ -526,7 +526,7 @@ A short human-friendly name (such as `sonnet` or `mini`) that gh-aw resolves to
		A top-level frontmatter field that caps the total AI Credits (AIC) the AWF proxy will spend within a single workflow run. Applies to all engines and maps to `apiProxy.maxAiCredits` in the compiled lock file. Defaults to `1000` when omitted. Accepts an integer, an optional `K`/`M` suffix string (for example, `100M`), or a GitHub Actions expression that resolves to an integer at runtime. Example:

		@@ -234,12 +234,7 @@ Environment variables can be defined at multiple scopes (workflow, job, step, en
		Sets the AWF AI Credits budget used for cost enforcement. It is enabled by default and defaults to `1000` (`1k`) when omitted. Steering (budget-warning messages at 80%, 90%, 95%, and 99% of the budget) is enabled by default. Use plain integers or `K`/`M` suffixes such as `100000K` or `100M`. Set to a negative value to disable both budget enforcement and steering.

		@@ -262,7 +262,7 @@ cost guardrail across all supported engines. The field accepts
		plain integers or `K`/`M` suffixes such as `100M`.

Conversation

Copilot AI commented Jun 13, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions Bot commented Jun 13, 2026

Uh oh!

pelikhan left a comment

Choose a reason for hiding this comment

Uh oh!

Copilot AI commented Jun 13, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Copilot's findings

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Copilot AI commented Jun 13, 2026 •

edited

Loading