-
-
Notifications
You must be signed in to change notification settings - Fork 5.9k
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
Added docs for agit-setup #21027
Changes from 2 commits
Commits
Show all changes
16 commits
Select commit
Hold shift + click to select a range
7da176c
Added docs for agit-setup
CypherpunkSamurai c4b16d7
Merge branch 'main' into main
6543 8dfb61b
Fix Lint errors
CypherpunkSamurai 30dc0d2
Merge branch 'main' into main
CypherpunkSamurai 42d37e9
Add suggested changes
CypherpunkSamurai 2b1ef77
Merge branch 'main' into main
6543 841fe47
Apply suggestions from code review
6543 637e275
Merge branch 'main' into main
6543 d11b3e5
Merge branch 'main' into main
zeripath 871eb07
Merge branch 'main' into main
6543 7c9edad
Update docs/content/doc/usage/agit-support.en-us.md
6543 45abb04
Merge branch 'main' into main
6543 6b1306b
Merge branch 'main' into main
lunny c103e88
fix lint
6543 de87d59
Merge branch 'main'
6543 e1a91c1
Merge branch 'main' into main
6543 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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" | ||
``` |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.