Add back deprecated /api/reset-settings endpoint to OpenAPI documentation

docs/modules/usage/how-to/gitlab-runner.md

@@ -1 +0,0 @@
-# Using GitLab CI Runners

frontend/__tests__/routes/home-screen.test.tsx

@@ -91,13 +91,6 @@ describe("HomeScreen", () => {
     screen.getByTestId("task-suggestions");
   });
 
-  it("should have responsive layout for mobile and desktop screens", async () => {
-    renderHomeScreen();
-    
-    const mainContainer = screen.getByTestId("home-screen").querySelector("main");
-    expect(mainContainer).toHaveClass("flex", "flex-col", "md:flex-row");
-  });
-
   it("should filter the suggested tasks based on the selected repository", async () => {
     const retrieveUserGitRepositoriesSpy = vi.spyOn(
       GitService,

frontend/src/routes/home.tsx

@@ -22,7 +22,7 @@ function HomeScreen() {
 
       <hr className="border-[#717888]" />
 
-      <main className="flex flex-col md:flex-row justify-between gap-4">
+      <main className="flex justify-between gap-4">
         <RepoConnector
           onRepoSelection={(title) => setSelectedRepoTitle(title)}
         />

microagents/add_openhands_repo_instruction.md

@@ -0,0 +1,64 @@
+---
+name: add_openhands_repo_instruction
+version: 1.0.0
+author: openhands
+agent: CodeActAgent
+inputs:
+  - name: REPO_FOLDER_NAME
+    description: "Branch for the agent to work on"
+    required: false
+---
+
+Please browse the current repository under /workspace/{{ REPO_FOLDER_NAME }}, look at the documentation and relevant code, and understand the purpose of this repository.
+
+Specifically, I want you to create a `.openhands/microagents/repo.md`  file. This file should contain succinct information that summarizes (1) the purpose of this repository, (2) the general setup of this repo, and (3) a brief description of the structure of this repo.
+
+Here's an example:
+```markdown
+---
+name: repo
+type: repo
+agent: CodeActAgent
+---
+
+This repository contains the code for OpenHands, an automated AI software engineer. It has a Python backend
+(in the `openhands` directory) and React frontend (in the `frontend` directory).
+
+## General Setup:
+To set up the entire repo, including frontend and backend, run `make build`.
+You don't need to do this unless the user asks you to, or if you're trying to run the entire application.
+
+Before pushing any changes, you should ensure that any lint errors or simple test errors have been fixed.
+
+* If you've made changes to the backend, you should run `pre-commit run --all-files --config ./dev_config/python/.pre-commit-config.yaml`
+* If you've made changes to the frontend, you should run `cd frontend && npm run lint:fix && npm run build ; cd ..`
+
+If either command fails, it may have automatically fixed some issues. You should fix any issues that weren't automatically fixed,
+then re-run the command to ensure it passes.
+
+## Repository Structure
+Backend:
+- Located in the `openhands` directory
+- Testing:
+  - All tests are in `tests/unit/test_*.py`
+  - To test new code, run `poetry run pytest tests/unit/test_xxx.py` where `xxx` is the appropriate file for the current functionality
+  - Write all tests with pytest
+
+Frontend:
+- Located in the `frontend` directory
+- Prerequisites: A recent version of NodeJS / NPM
+- Setup: Run `npm install` in the frontend directory
+- Testing:
+  - Run tests: `npm run test`
+  - To run specific tests: `npm run test -- -t "TestName"`
+- Building:
+  - Build for production: `npm run build`
+- Environment Variables:
+  - Set in `frontend/.env` or as environment variables
+  - Available variables: VITE_BACKEND_HOST, VITE_USE_TLS, VITE_INSECURE_SKIP_VERIFY, VITE_FRONTEND_PORT
+- Internationalization:
+  - Generate i18n declaration file: `npm run make-i18n`
+```
+
+Now, please write a similar markdown for the current repository.
+Read all the GitHub workflows under .github/ of the repository (if this folder exists) to understand the CI checks (e.g., linter, pre-commit), and include those in the repo.md file.

microagents/address_pr_comments.md

@@ -0,0 +1,19 @@
+---
+name: address_pr_comments
+version: 1.0.0
+author: openhands
+agent: CodeActAgent
+inputs:
+  - name: PR_URL
+    description: "URL of the pull request"
+    required: true
+  - name: BRANCH_NAME
+    description: "Branch name corresponds to the pull request"
+    required: true
+---
+
+First, check the branch {{ BRANCH_NAME }} and read the diff against the main branch to understand the purpose.
+
+This branch corresponds to this PR {{ PR_URL }}
+
+Next, you should use the GitHub API to read the reviews and comments on this PR and address them.

microagents/agent_memory.md

@@ -1,32 +0,0 @@
----
-name: agent_memory
-type: knowledge
-version: 1.0.0
-agent: CodeActAgent
-triggers:
-- /remember
----
-
-* Repository memory: Use .openhands/microagents/repo.md under each repository root to store and access important information.
-  - If this file exists, it will be added to your context automatically.
-  - If missing, you should create it unless the user has explicitly asked you to not do so.
-
-* Store and maintain **general knowledge** that will be helpful for most future tasks:
-  1. Repository structure
-  2. Common commands (build, lint, test, pre-commit, etc.)
-  3. Code style preferences
-  4. Workflows and best practices
-  5. Any other repository-specific knowledge you learn
-
-* IMPORTANT: ONLY LOG the information that would be helpful for different future tasks, for example, how to configure the settings, how to setup the repository. Do NOT add issue-specific information (e.g., what specific error you have ran into and how you fix it).
-
-* When adding new information:
-  - ALWAYS ask for user confirmation first by listing the exact items (numbered 1, 2, 3, etc.) you plan to save to repo.md
-  - Only save the items the user approves (they may ask you to save a subset)
-  - Ensure it integrates nicely with existing knowledge in repo.md
-  - Reorganize the content if needed to maintain clarity and organization
-  - Group related information together under appropriate sections or headings
-  - If you've only explored a portion of the codebase, clearly note this limitation in the repository structure documentation
-  - If you don't know the essential commands for working with the repository, such as lint or typecheck, ask the user and suggest adding them to repo.md for future reference (with permission)
-
-When you receive this message, please review and summarize your recent actions and observations, then present a list of valuable information that should be saved in repo.md to the user.

microagents/get_test_to_pass.md

@@ -0,0 +1,27 @@
+---
+name: get_test_to_pass
+version: 1.0.0
+author: openhands
+agent: CodeActAgent
+inputs:
+  - name: BRANCH_NAME
+    description: "Branch for the agent to work on"
+    required: true
+  - name: TEST_COMMAND_TO_RUN
+    description: "The test command you want the agent to work on. For example, `pytest tests/unit/test_bash_parsing.py`"
+    required: true
+  - name: FUNCTION_TO_FIX
+    description: "The name of function to fix"
+    required: false
+  - name: FILE_FOR_FUNCTION
+    description: "The path of the file that contains the function"
+    required: false
+---
+
+Can you check out branch "{{ BRANCH_NAME }}", and run {{ TEST_COMMAND_TO_RUN }}.
+
+{%- if FUNCTION_TO_FIX and FILE_FOR_FUNCTION %}
+Help me fix these tests to pass by fixing the {{ FUNCTION_TO_FIX }} function in file {{ FILE_FOR_FUNCTION }}.
+{%- endif %}
+
+PLEASE DO NOT modify the tests by yourselves -- Let me know if you think some of the tests are incorrect.

microagents/update_pr_description.md

@@ -0,0 +1,21 @@
+---
+name: update_pr_description
+version: 1.0.0
+author: openhands
+agent: CodeActAgent
+inputs:
+  - name: PR_URL
+    description: "URL of the pull request"
+    type: string
+    required: true
+    validation:
+      pattern: "^https://github.com/.+/.+/pull/[0-9]+$"
+  - name: BRANCH_NAME
+    description: "Branch name corresponds to the pull request"
+    type: string
+    required: true
+---
+
+Please check the branch "{{ BRANCH_NAME }}" and look at the diff against the main branch. This branch belongs to this PR "{{ PR_URL }}".
+
+Once you understand the purpose of the diff, please use Github API to read the existing PR description, and update it to be more reflective of the changes we've made when necessary.

microagents/update_test_for_new_implementation.md

@@ -0,0 +1,21 @@
+---
+name: update_test_for_new_implementation
+version: 1.0.0
+author: openhands
+agent: CodeActAgent
+inputs:
+  - name: BRANCH_NAME
+    description: "Branch for the agent to work on"
+    required: true
+  - name: TEST_COMMAND_TO_RUN
+    description: "The test command you want the agent to work on. For example, `pytest tests/unit/test_bash_parsing.py`"
+    required: true
+---
+
+Can you check out branch "{{ BRANCH_NAME }}", and run {{ TEST_COMMAND_TO_RUN }}.
+
+{%- if FUNCTION_TO_FIX and FILE_FOR_FUNCTION %}
+Help me fix these tests to pass by fixing the {{ FUNCTION_TO_FIX }} function in file {{ FILE_FOR_FUNCTION }}.
+{%- endif %}
+
+PLEASE DO NOT modify the tests by yourselves -- Let me know if you think some of the tests are incorrect.

openhands/resolver/README.md

@@ -1,141 +1,191 @@
-# OpenHands GitHub & GitLab Issue Resolver 🙌
+# OpenHands Github & Gitlab Issue Resolver 🙌
 
-Need help resolving GitHub or GitLab issues? Let an AI agent help you out!
+Need help resolving a GitHub issue but don't have the time to do it yourself? Let an AI agent help you out!
 
-This tool uses [OpenHands](https://github.com/all-hands-ai/openhands) AI agents to automatically resolve issues in your repositories. It's designed to handle one issue at a time with high quality.
+This tool allows you to use open-source AI agents based on [OpenHands](https://github.com/all-hands-ai/openhands)
+to attempt to resolve GitHub issues automatically. While it can handle multiple issues, it's primarily designed
+to help you resolve one issue at a time with high quality.
 
-## 1. Setting Up for GitHub (Action Workflow)
+Getting started is simple - just follow the instructions below.
 
-### Prerequisites
+## Using the GitHub Actions Workflow
 
-- [Create a personal access token](https://github.com/settings/tokens?type=beta) with read/write scope for
+This repository includes a GitHub Actions workflow that can automatically attempt to fix individual issues labeled with 'fix-me'.
+Follow these steps to use this workflow in your own repository:
 
-  - "contents"
-  - "issues"
-  - "pull requests"
-  - "workflows"
+1. [Create a personal access token](https://github.com/settings/tokens?type=beta) with read/write scope for "contents", "issues", "pull requests", and "workflows"
 
-- Create an LLM API key (e,g [Claude API](https://www.anthropic.com/api))
+   Note: If you're working with an organizational repository, you may need to configure the organization's personal access token policy first. See [Setting a personal access token policy for your organization](https://docs.github.com/en/organizations/managing-programmatic-access-to-your-organization/setting-a-personal-access-token-policy-for-your-organization) for details.
 
-### Installation
+2. Create an API key for the [Claude API](https://www.anthropic.com/api) (recommended) or another supported LLM service
 
-1. Copy `examples/openhands-resolver.yml` to your repository's `.github/workflows/` directory
+3. Copy `examples/openhands-resolver.yml` to your repository's `.github/workflows/` directory
 
-2. Configure repository permissions:
+4. Configure repository permissions:
+    - Go to `Settings -> Actions -> General -> Workflow permissions`
+    - Select "Read and write permissions"
+    - Enable "Allow Github Actions to create and approve pull requests"
 
-   - Go to `Settings -> Actions -> General -> Workflow permissions`
-   - Select **Read and write permissions**
-   - Enable **Allow Github Actions to create and approve pull requests**
-
-   > If "Read and write permissions" is greyed out:
-   >
-   > - Check organization settings first
-   > - Otherwise, permissions might need to be set in [Enterprise policy settings](https://docs.github.com/en/enterprise-cloud@latest/admin/enforcing-policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise#enforcing-a-policy-for-workflow-permissions-in-your-enterprise)
-
-3. Set up [GitHub secrets](https://docs.github.com/en/actions/security-for-github-actions/security-guides/using-secrets-in-github-actions):
+    Note: If the "Read and write permissions" option is greyed out:
+    - First check if permissions need to be set at the organization level
+    - If still greyed out at the organization level, permissions need to be set in the [Enterprise policy settings](https://docs.github.com/en/enterprise-cloud@latest/admin/enforcing-policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise#enforcing-a-policy-for-workflow-permissions-in-your-enterprise)
 
+5. Set up [GitHub secrets](https://docs.github.com/en/actions/security-for-github-actions/security-guides/using-secrets-in-github-actions):
    - Required:
-     - `LLM_API_KEY`: Your LLM API key
+    - `LLM_API_KEY`: Your LLM API key
    - Optional:
      - `PAT_USERNAME`: GitHub username for the personal access token
      - `PAT_TOKEN`: The personal access token
      - `LLM_BASE_URL`: Base URL for LLM API (only if using a proxy)
-     - [See how to customize more configurations](https://docs.all-hands.dev/modules/usage/how-to/github-action#custom-configurations)
 
-## 2. Setting up GitLab (CI Runner)
+   Note: You can set these secrets at the organization level to use across multiple repositories.
 
-### Prerequisites
+6. Set up any [custom configurations required](https://docs.all-hands.dev/modules/usage/how-to/github-action#custom-configurations)
 
-Create a GitLab Personal Access Token with API, read/write access
+7. Usage:
+   There are two ways to trigger the OpenHands agent:
 
-### Installation
+   a. Using the 'fix-me' label:
+      - Add the 'fix-me' label to any issue you want the AI to resolve
+      - The agent will consider all comments in the issue thread when resolving
+      - The workflow will:
+        1. Attempt to resolve the issue using OpenHands
+        2. Create a draft PR if successful, or push a branch if unsuccessful
+        3. Comment on the issue with the results
+        4. Remove the 'fix-me' label once processed
 
-## 3. Triggering OpenHands Agent
+   b. Using `@openhands-agent` mention:
+      - Create a new comment containing `@openhands-agent` in any issue
+      - The agent will only consider the comment where it's mentioned
+      - The workflow will:
+        1. Attempt to resolve the issue based on the specific comment
+        2. Create a draft PR if successful, or push a branch if unsuccessful
+        3. Comment on the issue with the results
 
-You can trigger OpenHands in two shared ways (works for both GitHub and GitLab):
+Need help? Feel free to [open an issue](https://github.com/all-hands-ai/openhands/issues) or email us at [contact@all-hands.dev](mailto:contact@all-hands.dev).
 
-Using the 'fix-me' label:
+## Manual Installation
 
-- Add the 'fix-me' label to any issue you want the AI to resolve
-- The agent will consider all comments in the issue thread when resolving
+If you prefer to run the resolver programmatically instead of using GitHub Actions, follow these steps:
 
-Using `@openhands-agent` in an issue/pr comment:
-
-- Create a new comment containing `@openhands-agent`
-- The agent will only consider the comment + comment thread where it's mentioned
-
-## 4. Running Locally
-
-### Installation
+1. Install the package:
 
 ```bash
 pip install openhands-ai
 ```
 
-### Setup
+2. Create a GitHub or GitLab access token:
+   - Create a GitHub acces token
+      - Visit [GitHub's token settings](https://github.com/settings/personal-access-tokens/new)
+      - Create a fine-grained token with these scopes:
+      - "Content"
+      - "Pull requests"
+      - "Issues"
+      - "Workflows"
+      - If you don't have push access to the target repo, you can fork it first
 
-Create a GitHub or GitLab access token with appropriate permissions
+   - Create a GitLab acces token
+      - Visit [GitLab's token settings](https://gitlab.com/-/user_settings/personal_access_tokens)
+      - Create a fine-grained token with these scopes:
+      - 'api'
+      - 'read_api'
+      - 'read_user'
+      - 'read_repository'
+      - 'write_repository'
 
-Set up environment variables:
+3. Set up environment variables:
 
 ```bash
-# GitHub credentials
-export GITHUB_TOKEN="your-github-token"
-export GIT_USERNAME="your-github-username"
 
-# GitLab credentials (if using GitLab)
+# GitHub credentials
+
+export GITHUB_TOKEN="your-github-token"
+export GIT_USERNAME="your-github-username"  # Optional, defaults to token owner
+
+# GitLab credentials if you're using GitLab repo
+
 export GITLAB_TOKEN="your-gitlab-token"
-export GIT_USERNAME="your-gitlab-username"
+export GIT_USERNAME="your-gitlab-username"  # Optional, defaults to token owner
 
 # LLM configuration
-export LLM_MODEL="anthropic/claude-3-5-sonnet-20241022"
+
+export LLM_MODEL="anthropic/claude-3-5-sonnet-20241022"  # Recommended
 export LLM_API_KEY="your-llm-api-key"
-export LLM_BASE_URL="your-api-url"  # Optional
+export LLM_BASE_URL="your-api-url"  # Optional, for API proxies
 ```
 
-### Resolving Issues
+Note: OpenHands works best with powerful models like Anthropic's Claude or OpenAI's GPT-4. While other models are supported, they may not perform as well for complex issue resolution.
 
-Resolve a single issue:
+## Resolving Issues
+
+The resolver can automatically attempt to fix a single issue in your repository using the following command:
 
 ```bash
 python -m openhands.resolver.resolve_issue --selected-repo [OWNER]/[REPO] --issue-number [NUMBER]
 ```
 
-### Responding to PR Comments
+For instance, if you want to resolve issue #100 in this repo, you would run:
 
-Respond to comments on pull requests:
+```bash
+python -m openhands.resolver.resolve_issue --selected-repo all-hands-ai/openhands --issue-number 100
+```
+
+The output will be written to the `output/` directory.
+
+If you've installed the package from source using poetry, you can use:
+
+```bash
+poetry run python openhands/resolver/resolve_issue.py --selected-repo all-hands-ai/openhands --issue-number 100
+```
+
+## Responding to PR Comments
+
+The resolver can also respond to comments on pull requests using:
 
 ```bash
 python -m openhands.resolver.send_pull_request --issue-number PR_NUMBER --issue-type pr
 ```
 
-### Visualizing Results
+This functionality is available both through the GitHub Actions workflow and when running the resolver locally.
 
-View successful PRs:
+## Visualizing successful PRs
+
+To find successful PRs, you can run the following command:
 
 ```bash
 grep '"success":true' output/output.jsonl | sed 's/.*\("number":[0-9]*\).*/\1/g'
 ```
 
-Visualize specific PR:
+Then you can go through and visualize the ones you'd like.
 
 ```bash
 python -m openhands.resolver.visualize_resolver_output --issue-number ISSUE_NUMBER --vis-method json
 ```
 
-### Uploading PRs
+## Uploading PRs
 
-Upload your changes in one of three ways:
+If you find any PRs that were successful, you can upload them.
+There are three ways you can upload:
+
+1. `branch` - upload a branch without creating a PR
+2. `draft` - create a draft PR
+3. `ready` - create a non-draft PR that's ready for review
 
 ```bash
-python -m openhands.resolver.send_pull_request --issue-number ISSUE_NUMBER --username YOUR_GITHUB_OR_GITLAB_USERNAME --pr-type [branch|draft|ready]
+python -m openhands.resolver.send_pull_request --issue-number ISSUE_NUMBER --username YOUR_GITHUB_OR_GITLAB_USERNAME --pr-type draft
 ```
 
-## Custom Instructions
+If you want to upload to a fork, you can do so by specifying the `fork-owner`:
 
-Add repository-specific instructions by creating a file at `.openhands/microagents/repo.md` in your repository. For more information about repository microagents, see [Repository Instructions](https://github.com/All-Hands-AI/OpenHands/tree/main/microagents#2-repository-instructions-private).
+```bash
+python -m openhands.resolver.send_pull_request --issue-number ISSUE_NUMBER --username YOUR_GITHUB_OR_GITLAB_USERNAME --pr-type draft --fork-owner YOUR_GITHUB_OR_GITLAB_USERNAME
+```
+
+## Providing Custom Instructions
+
+You can customize how the AI agent approaches issue resolution by adding a repository microagent file at `.openhands/microagents/repo.md` in your repository. This file's contents will be automatically loaded in the prompt when working with your repository. For more information about repository microagents, see [Repository Instructions](https://github.com/All-Hands-AI/OpenHands/tree/main/microagents#2-repository-instructions-private).
 
 ## Troubleshooting
 
-If you have any issues, please open an issue on this github repo, we're happy to help!
+If you have any issues, please open an issue on this github or gitlab repo, we're happy to help!
 Alternatively, you can [email us](mailto:contact@all-hands.dev) or join the OpenHands Slack workspace (see [the README](/README.md) for an invite link).