OpenHands/docs/modules/usage/how-to/github-action.md

Using the OpenHands GitHub Action

This guide explains how to use the OpenHands GitHub Action, both within the OpenHands repository and in your own projects.

Using the Action in the OpenHands Repository

To use the OpenHands GitHub Action in a repository, you can:

1. Create an issue in the repository.
2. Add the fix-me label to the issue or leave a comment on the issue starting with @openhands-agent.

The action will automatically trigger and attempt to resolve the issue.

Installing the Action in a New Repository

To install the OpenHands GitHub Action in your own repository, follow the README for the OpenHands Resolver.

Usage Tips

Iterative resolution

1. Create an issue in the repository.
2. Add the fix-me label to the issue, or leave a comment starting with @openhands-agent
3. Review the attempt to resolve the issue by checking the pull request
4. Follow up with feedback through general comments, review comments, or inline thread comments
5. Add the fix-me label to the pull request, or address a specific comment by starting with @openhands-agent

Label versus Macro

• Label (fix-me): Requests OpenHands to address the entire issue or pull request.
• Macro (@openhands-agent): Requests OpenHands to consider only the issue/pull request description and the specific comment.

Advanced Settings

Add custom repository settings

You can provide custom directions for OpenHands by following the README for the resolver.

Configure custom macro

To customize the default macro (@openhands-agent):

1. Create a repository variable named OPENHANDS_MACRO
2. Assign the variable a custom value