Skip to content

[instructions] Sync instruction files with release v0.81.6 - #42702

Merged
pelikhan merged 1 commit into
mainfrom
instructions-sync-setup-cli-anchors-95980e4536b3b6a8
Jul 1, 2026
Merged

[instructions] Sync instruction files with release v0.81.6#42702
pelikhan merged 1 commit into
mainfrom
instructions-sync-setup-cli-anchors-95980e4536b3b6a8

Conversation

@github-actions

@github-actions github-actions Bot commented Jul 1, 2026

Copy link
Copy Markdown
Contributor

Summary

Documentation-only fixes to instruction files, synced with release v0.81.6. Corrects a stale action reference and two broken cross-reference links.

Changes

File Change
.github/aw/debug-agentic-workflow.md Fixed action reference: actions/setup-cli to github/gh-aw/actions/setup-cli
.github/aw/runbooks/workflow-health.md Same action reference fix; replaced broken link to cli-commands.md
.github/aw/token-optimization.md Fixed broken cross-reference to syntax-agentic.md#agentic-workflow-specific-fields

Details

The setup-cli action was incorrectly referenced by the short form actions/setup-cli in two instruction files. The correct fully-qualified reference is github/gh-aw/actions/setup-cli.

Cross-reference fixes:

  • workflow-health.md: Replaced stale anchor github-agentic-workflows.md#logs-and-metrics with direct link to cli-commands.md.
  • token-optimization.md: Updated syntax.md#observability to syntax-agentic.md#agentic-workflow-specific-fields.

Impact

  • Code: none
  • Behaviour: none
  • Documentation: fixes stale/broken links and an incorrect action reference in agent-facing instruction files

Generated by PR Description Updater for #42702 · 37.5 AIC · ⌖ 9.01 AIC · ⊞ 4.7K ·

Correct the setup-cli action reference and repair two broken
intra-doc anchor links found during the instructions accuracy audit.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@github-actions github-actions Bot added automation documentation Improvements or additions to documentation instructions labels Jul 1, 2026
@github-actions

This comment has been minimized.

@github-actions

github-actions Bot commented Jul 1, 2026

Copy link
Copy Markdown
Contributor Author

👋 Thanks for the tidy accuracy pass — fixing a wrong action org prefix and two dead anchors in the instruction files is exactly the kind of hygiene that keeps agents from following stale guidance.

One thing worth considering:

  • No test coverage — the diff is purely in .md files, so traditional unit tests don't apply. That said, an automated anchor-validation step (e.g. a script or CI job that crawls .github/aw/**/*.md for broken #fragment links) would catch regressions like these before they ship and make future janitor passes smaller.

If you'd like to add that guard, here's a prompt you can hand off to an agent:

Add a CI check (or Makefile target) that validates all intra-doc anchor links in `.github/aw/**/*.md`.
For each `[text](file.md#fragment)` reference found in those files:
1. Confirm the target file exists.
2. Confirm a heading whose slugified form matches the fragment exists in that file.
Report any broken references as errors and exit non-zero so the check can be wired into CI.

Generated by ✅ Contribution Check · 217.3 AIC · ⌖ 27.5 AIC · ⊞ 6.3K ·

@pelikhan
pelikhan merged commit 020bd3e into main Jul 1, 2026
@pelikhan
pelikhan deleted the instructions-sync-setup-cli-anchors-95980e4536b3b6a8 branch July 1, 2026 11:11
@github-actions

github-actions Bot commented Jul 2, 2026

Copy link
Copy Markdown
Contributor Author

🎉 This pull request is included in a new release.

Release: v0.82.2

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

Labels

automation documentation Improvements or additions to documentation instructions

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant