MirrorHub/forgejo
0
0
Fork 0
mirror of https://codeberg.org/forgejo/forgejo.git synced 2024-11-27 02:43:23 +01:00
Code Issues Projects Releases Packages Wiki Activity
forgejo/docs/content/doc/usage/agit-support.en-us.md
Cypherpunk Samurai 82c6f7bf4a
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>
2022-09-03 19:52:19 +02:00

1.5 KiB
Raw Blame History

date title slug weight toc draft menu
2022-09-01T20:50:42+0000 Usage: Agit Setup agit-setup 12 false false
sidebar
parent name weight identifier
usage Agit Setup 12 agit-setup

Agit Setup

In Gitea 1.13, support for agit 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:

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:

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"