diff options
| author | Cypherpunk Samurai <66906402+CypherpunkSamurai@users.noreply.github.com> | 2022-09-03 23:22:19 +0530 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-09-03 19:52:19 +0200 |
| commit | 82c6f7bf4afaa064035daae6094649d47cc3bc70 (patch) | |
| tree | eadb7d975228e36cc0958c3f995aaf8e4cd88d75 /docs | |
| parent | 58a80ba69c73715dfc527ec1ee327f7c6ad4c1d6 (diff) | |
| download | gitea-82c6f7bf4afaa064035daae6094649d47cc3bc70.tar.gz gitea-82c6f7bf4afaa064035daae6094649d47cc3bc70.zip | |
Added docs for agit-setup (#21027)
This PR Adds Documentation for the new Agit feature. Agit allows creating PR directly while pushing code.
Close #21018
Co-authored-by: CypherpunkSamurai <CypherpunkSamurai@users.noreply.github.com>
Co-authored-by: delvh <dev.lh@web.de>
Co-authored-by: a1012112796 <1012112796@qq.com>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/content/doc/usage/agit-support.en-us.md | 47 |
1 files changed, 47 insertions, 0 deletions
diff --git a/docs/content/doc/usage/agit-support.en-us.md b/docs/content/doc/usage/agit-support.en-us.md new file mode 100644 index 0000000000..c71be68370 --- /dev/null +++ b/docs/content/doc/usage/agit-support.en-us.md @@ -0,0 +1,47 @@ +--- +date: " 2022-09-01T20:50:42+0000" +title: "Usage: Agit Setup" +slug: "agit-setup" +weight: 12 +toc: false +draft: false +menu: + sidebar: + parent: "usage" + name: "Agit Setup" + weight: 12 + identifier: "agit-setup" +--- + +# Agit Setup + +In Gitea `1.13`, support for [agit](https://git-repo.info/en/2020/03/agit-flow-and-git-repo/) was added. + +## 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: + +```shell +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`: confirm force update the target branch + +Here's another advanced example for creating a new PR targeting `master` with `topic`, `title`, and `description`: + +```shell +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" +``` |