Skip to content

Added docs for agit-setup #21027

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 16 commits into from
Sep 3, 2022
Merged
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
57 changes: 57 additions & 0 deletions docs/content/doc/usage/agit-support.en-us.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
---
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 PR with Agit
Agit allows creating a PR while pushing code to the remote repo. This requires using a speacial command refspec.

- `HEAD`

Target branch

- `refs/<for|drafts|for-review>/`

Target PR Type.
* `for` - Normal PR
* `draft` - Draft PR
* `for-review` - Generate a PR ID for updating existing PR.

- `<target-branch>/<session>`

Target remote branch to open a PR.

- `-o <topic|title|description>`

Options for the PR
* `title` - Title of the PR.
* `topic` - Topic of the PR.
* `description` - Description of the PR. (Contents in Markdown format)

## Examples

Example of pushing a repo with a PR:

```shell
git push origin HEAD:refs/for/master
```

Example of pushing a repo with a PR `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 markdown formatted.\n[x] Ok"
```