[docs] Add documentation for gh aw fix command#6391
Merged
Conversation
Add comprehensive documentation for the new `gh aw fix` command introduced in PR #6367. This command automatically migrates deprecated workflow fields using codemods. Documentation includes: - Command description and usage examples - Available codemods with version information - Dry-run mode (default) and --write flag - Integration with compile command and make targets - All options and flags 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
github-actions
bot
added
automation
documentation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds comprehensive documentation for the new gh aw fix command, which provides automatic codemod-style migrations for deprecated workflow fields. The documentation follows the Diátaxis framework for reference documentation.
Key Changes:
- Documented the new
fixcommand with usage examples, available codemods, and version information - Added
--fixflag documentation to thecompilecommand - Explained integration between
fixandcompilecommands
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Documentation Updates - 2025-12-14
This PR updates the documentation based on features merged in the last 24 hours.
Features Documented
gh aw fixcommand (from PR Add fix command for automatic codemod-style migrations of deprecated workflow fields #6367) - New codemod-style command for automatic migration of deprecated workflow fieldsChanges Made
docs/src/content/docs/setup/cli.md:fixcommand section under "Building" commands--writeflagtimeout_minutes→timeout-minutes(v0.1.0)network.firewall→sandbox.agent(v0.1.0)on.command→on.slash_command(v0.2.0)gh aw compile --fixandmake fix--fixflag documentation tocompilecommand--list-codemodsflag documentationMerged PRs Referenced
Other Recent PRs Reviewed
All 28 merged PRs from the last 24 hours were reviewed. The other PRs either:
Documentation Guidelines
This documentation follows the Diátaxis framework principles:
awlanguage tag for command examples