Skip to content

pr-fix.md

Latest commit

 

History

History
85 lines (56 loc) · 2.98 KB

pr-fix.md

File metadata and controls

85 lines (56 loc) · 2.98 KB

🔧 PR Fix

For an overview of all available workflows, see the main README.

The "@pr-fix" workflow is an alias workflow "@pr-fix" that will help you fix and complete pull requests. By default it will analyze failing CI checks in pull requests, identify root causes, and implement fixes to resolve issues and get PRs back to a passing state.

You can trigger the workflow in default mode by adding a comment to a pull request with the command:

/pr-fix

or by writing a comment:

/pr-fix Please add more tests.

Installation

# Install the 'gh aw' extension
gh extension install github/gh-aw

# Add the PR Fix workflow to your repository
gh aw add githubnext/agentics/pr-fix

This walks you through adding the workflow to your repository.

You can't start a run of this workflow directly as it is triggered in the context of a pull request with failing checks.

To trigger the workflow on a specific pull request, add a comment with the command:

/pr-fix

Mandatory Checklist

  • I have read the notes on coding tasks in the main README and understand the implications.

  • I will review all pull requests very carefully, and carefully monitor the repository.

Configuration

This workflow requires no configuration and works out of the box. You can use local configuration to specify custom build commands, testing procedures, linting rules, and code formatting standards. Local configuration can be done in .github/workflows/agentics/pr-fix.config.md.

After editing run gh aw compile to update the workflow and commit all changes to the default branch.

What it reads from GitHub

  • Pull request details, files, and metadata
  • Workflow run logs and job outputs
  • Check run results and status information
  • Commit information and diff context
  • Repository contents and file structure
  • Existing issues related to CI failures

What it creates

  • Pushes fixes directly to the pull request branch
  • Adds comments to pull requests explaining the changes made
  • May create issues for complex problems requiring human intervention
  • Requires contents: write and pull-requests: write permissions

What web searches it performs

  • Searches for error message documentation and solutions
  • Looks up best practices for specific technologies and frameworks
  • Researches common fixes for build and test failures

Human in the loop

  • Review all changes pushed by the workflow before merging the PR
  • Validate that fixes actually resolve the intended issues
  • Monitor for any unintended side effects or regressions
  • Provide additional context or instructions via PR comments when needed
  • Override or revert changes if the automated fix is incorrect

Activity duration

  • By default this workflow will run for up to 48 hours after being triggered
  • The workflow stops automatically after this period to prevent indefinite runs
  • You can re-trigger the workflow by commenting with the alias again if needed