foster/forgejo
1
0
Fork 0
mirror of https://codeberg.org/forgejo/forgejo.git synced 2024-12-28 13:49:13 -05:00
Code Issues Wiki Activity
forgejo/docs/content/usage/agit-support.en-us.md
Giteabot 148f6e3776
Change the default branch in the agit docs (#27621) (#27623) 
Backport #27621 by @lng2020

It's main now.
relevant #27579

Co-authored-by: Nanguan Lin <70063547+lng2020@users.noreply.github.com>
2023-10-15 09:16:15 +08:00

1.5 KiB
Raw Blame History

date title slug sidebar_position toc draft aliases menu
2022-09-01T20:50:42+0000 Agit Setup agit-setup 12 false false
/en-us/agit-setup
sidebar
parent name sidebar_position 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/main

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 main with topic, title, and description:

git push origin HEAD:refs/for/main -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"