oppi.li / perf-test
loading up the forgejo repo on tangled to test page performance
0
fork

Configure Feed

Select the types of activity you want to include in your feed.

Update agit-support.en-us.md (#27652)

Clarify Agit PR creation documentation

See https://github.com/go-gitea/gitea/issues/27579

authored by

Sandro Santilli and committed by
GitHub 0f3ea4e1 0271114e

+9 -6
+9 -6
docs/content/usage/agit-support.en-us.md
··· 18 18 # Agit Setup 19 19 20 20 In Gitea `1.13`, support for [agit](https://git-repo.info/en/2020/03/agit-flow-and-git-repo/) was added. 21 + **Note**: git version 2.29 or higher is required on the server side for this to work. 21 22 22 23 ## Creating PRs with Agit 23 24 ··· 32 33 The command has the following structure: 33 34 34 35 - `HEAD`: The target branch 35 - - `refs/<for|draft|for-review>/<branch>`: The target PR type 36 + - `origin`: The target repository (not a fork!) 37 + - `HEAD`: The local branch containing the changes you are proposing 38 + - `refs/<for|draft|for-review>/<branch>`: The target PR type and configuration 36 39 - `for`: Create a normal PR with `<branch>` as the target branch 37 - - `draft`/ `for-review`: Currently ignored silently 38 - - `<branch>/<session>`: The target branch to open the PR 40 + - `draft`/`for-review`: Currently ignored silently 41 + - `<branch>/`: The branch you want your changes to be merged into 39 42 - `-o <topic|title|description>`: Options for the PR 40 - - `title`: The PR title 41 - - `topic`: The branch name the PR should be opened for 42 - - `description`: The PR description 43 + - `topic`: The topic of this change. It will become the name of the branch holding the changes waiting for review. This is REQUIRED to trigger a pull request. 44 + - `title`: The PR title (optional but recommended), only used for topics not already having an associated PR. 45 + - `description`: The PR description (optional but recommended), only used for topics not already having an associated PR. 43 46 - `force-push`: confirm force update the target branch 44 47 45 48 Here's another advanced example for creating a new PR targeting `main` with `topic`, `title`, and `description`: