Merge push to create, open PR from push, and push options docs articles into one (#23744)

Add documentation for this feature.

<img width="734" alt="gitea-push-hint"
src="https://user-images.githubusercontent.com/81045/227921177-af08ab76-7556-4a69-8da9-bb59cec1388b.png">

---------

Co-authored-by: delvh <dev.lh@web.de>
This commit is contained in:
Lunny Xiao 2023-04-07 07:36:19 +08:00 committed by GitHub
parent e5dcd6aada
commit 8857e97b5f
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
5 changed files with 107 additions and 73 deletions

View file

@ -1,33 +0,0 @@
---
date: "2020-07-06T16:00:00+02:00"
title: "Push Options"
slug: "push-options"
weight: 15
toc: false
draft: false
menu:
sidebar:
parent: "usage"
name: "Push Options"
weight: 15
identifier: "push-options"
---
# Push Options
In Gitea `1.13`, support for some [push options](https://git-scm.com/docs/git-push#Documentation/git-push.txt--oltoptiongt)
were added.
## Supported Options
- `repo.private` (true|false) - Change the repository's visibility.
This is particularly useful when combined with push-to-create.
- `repo.template` (true|false) - Change whether the repository is a template.
Example of changing a repository's visibility to public:
```shell
git push -o repo.private=false -u origin main
```

View file

@ -1,33 +0,0 @@
---
date: "2020-07-06T16:00:00+02:00"
title: "Push Options"
slug: "push-options"
weight: 15
toc: false
draft: false
menu:
sidebar:
parent: "usage"
name: "Push Options"
weight: 15
identifier: "push-options"
---
# Push Options
Gitea 從 `1.13` 版開始支援某些 [push options](https://git-scm.com/docs/git-push#Documentation/git-push.txt--oltoptiongt)
## 支援的 Options
- `repo.private` (true|false) - 修改儲存庫的可見性。
與 push-to-create 一起使用時特別有用。
- `repo.template` (true|false) - 修改儲存庫是否為範本儲存庫。
以下範例修改儲存庫的可見性為公開:
```shell
git push -o repo.private=false -u origin main
```

View file

@ -1,18 +1,51 @@
--- ---
date: "2020-07-06T16:00:00+02:00" date: "2020-07-06T16:00:00+02:00"
title: "Push To Create" title: "Usage: Push"
slug: "push-to-create" slug: "push"
weight: 15 weight: 15
toc: false toc: false
draft: false draft: false
menu: menu:
sidebar: sidebar:
parent: "usage" parent: "usage"
name: "Push To Create" name: "Push"
weight: 15 weight: 15
identifier: "push-to-create" identifier: "push"
--- ---
**Table of Contents**
{{< toc >}}
There are some additional features when pushing commits to Gitea server.
# Open PR through Push
When you push commits to a non-default branch for the first time,
you will receive a link you can click on to visit the compare page of your branch compared to your main branch.
From there, it's easy to create a pull request, even if you want to target another branch.
![Gitea Push Hint](/gitea-push-hint.png)
# Push Options
In Gitea `1.13`, support for some [push options](https://git-scm.com/docs/git-push#Documentation/git-push.txt--oltoptiongt)
were added.
## Supported Options
- `repo.private` (true|false) - Change the repository's visibility.
This is particularly useful when combined with push-to-create.
- `repo.template` (true|false) - Change whether the repository is a template.
Example of changing a repository's visibility to public:
```shell
git push -o repo.private=false -u origin main
```
# Push To Create # Push To Create
Push to create is a feature that allows you to push to a repository that does not exist yet in Gitea. This is useful for automation and for allowing users to create repositories without having to go through the web interface. This feature is disabled by default. Push to create is a feature that allows you to push to a repository that does not exist yet in Gitea. This is useful for automation and for allowing users to create repositories without having to go through the web interface. This feature is disabled by default.
@ -35,6 +68,4 @@ git push -u origin main
This assumes you are using an SSH remote, but you can also use HTTPS remotes as well. This assumes you are using an SSH remote, but you can also use HTTPS remotes as well.
## Push options (bonus) Push-to-create will default to the visibility defined by `DEFAULT_PUSH_CREATE_PRIVATE` in `app.ini`.
Push-to-create will default to the visibility defined by `DEFAULT_PUSH_CREATE_PRIVATE` in `app.ini`. To explicitly set the visibility, you can use a [push option]({{< relref "doc/usage/push-options.en-us.md" >}}).

View file

@ -0,0 +1,69 @@
---
date: "2020-07-06T16:00:00+02:00"
title: "使用: Push"
slug: "push"
weight: 15
toc: false
draft: false
menu:
sidebar:
parent: "usage"
name: "Push"
weight: 15
identifier: "push"
---
**Table of Contents**
{{< toc >}}
There are some additional features when pushing commits to Gitea server.
# Push Merge Hint
When you pushing commits to a non-default branch, you will get an information from
Gitea which is a link, you can click the link and go to a compare page. It's a quick
way to create a pull request or a code review yourself in the Gitea UI.
![Gitea Push Hint](/gitea-push-hint.png)
# Push Options
Gitea 從 `1.13` 版開始支援某些 [push options](https://git-scm.com/docs/git-push#Documentation/git-push.txt--oltoptiongt)
## 支援的 Options
- `repo.private` (true|false) - 修改儲存庫的可見性。
與 push-to-create 一起使用時特別有用。
- `repo.template` (true|false) - 修改儲存庫是否為範本儲存庫。
以下範例修改儲存庫的可見性為公開:
```shell
git push -o repo.private=false -u origin main
```
# Push To Create
Push to create is a feature that allows you to push to a repository that does not exist yet in Gitea. This is useful for automation and for allowing users to create repositories without having to go through the web interface. This feature is disabled by default.
## Enabling Push To Create
In the `app.ini` file, set `ENABLE_PUSH_CREATE_USER` to `true` and `ENABLE_PUSH_CREATE_ORG` to `true` if you want to allow users to create repositories in their own user account and in organizations they are a member of respectively. Restart Gitea for the changes to take effect. You can read more about these two options in the [Configuration Cheat Sheet]({{< relref "doc/administration/config-cheat-sheet.zh-tw.md#repository-repository" >}}).
## Using Push To Create
Assuming you have a git repository in the current directory, you can push to a repository that does not exist yet in Gitea by running the following command:
```shell
# Add the remote you want to push to
git remote add origin git@{domain}:{username}/{repo name that does not exist yet}.git
# push to the remote
git push -u origin main
```
This assumes you are using an SSH remote, but you can also use HTTPS remotes as well.

BIN
docs/static/gitea-push-hint.png vendored Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 412 KiB