Skip to main content
Version: 1.20.6

AGit Setup

In Gitea 1.13, support for AGit was added. AGit enables users to create pull requests directly, even without write permissions of the repository, eliminating the need to fork it. This helps reduce the number of duplicated repositories and minimizes unnecessary disk usage.

note

Git version 2.29 or higher is required on the server side for this to work.

Creating PRs with AGit​

AGit allows to create PRs while pushing code to the remote repo. This can be done by pushing to the branch followed by a specific refspec (a location identifier known to git). The following example illustrates this:

git push origin HEAD:refs/for/master

The command has the following structure:

  • HEAD: The target branch
  • refs/<for|draft|for-review>/<branch>: The target PR type
    • for: Create a normal PR with <branch> as the target branch
    • draft/ for-review: Currently ignored silently
  • <branch>/<session>: The target branch to open the PR
  • -o <topic|title|description>: Options for the PR
    • title: The PR title
    • topic: The branch name the PR should be opened for
    • description: The PR description
    • force-push=true: Specifies whether to force-update the target branch.
      • Note: omitting the value and using just -o force-push will not work.

Here's another advanced example for creating a new PR targeting master with topic, title, and description:

git push origin HEAD:refs/for/master -o topic="Topic of my PR" -o title="Title of the PR" -o description="# The PR Description\nThis can be **any** markdown content.\n- [x] Ok"