diff --git a/docs/content/doc/usage/push-options.en-us.md b/docs/content/doc/usage/push-options.en-us.md deleted file mode 100644 index 5ed7b47da..000000000 --- a/docs/content/doc/usage/push-options.en-us.md +++ /dev/null @@ -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 -``` diff --git a/docs/content/doc/usage/push-options.zh-tw.md b/docs/content/doc/usage/push-options.zh-tw.md deleted file mode 100644 index 49133ce7f..000000000 --- a/docs/content/doc/usage/push-options.zh-tw.md +++ /dev/null @@ -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 -``` diff --git a/docs/content/doc/usage/push-to-create.en-us.md b/docs/content/doc/usage/push.en-us.md similarity index 56% rename from docs/content/doc/usage/push-to-create.en-us.md rename to docs/content/doc/usage/push.en-us.md index c461b4002..cf858e4e5 100644 --- a/docs/content/doc/usage/push-to-create.en-us.md +++ b/docs/content/doc/usage/push.en-us.md @@ -1,18 +1,51 @@ --- date: "2020-07-06T16:00:00+02:00" -title: "Push To Create" -slug: "push-to-create" +title: "Usage: Push" +slug: "push" weight: 15 toc: false draft: false menu: sidebar: parent: "usage" - name: "Push To Create" + name: "Push" 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 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. -## Push options (bonus) - -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" >}}). +Push-to-create will default to the visibility defined by `DEFAULT_PUSH_CREATE_PRIVATE` in `app.ini`. diff --git a/docs/content/doc/usage/push.zh-tw.md b/docs/content/doc/usage/push.zh-tw.md new file mode 100644 index 000000000..f97d4285c --- /dev/null +++ b/docs/content/doc/usage/push.zh-tw.md @@ -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. diff --git a/docs/static/gitea-push-hint.png b/docs/static/gitea-push-hint.png new file mode 100644 index 000000000..6f3ab3c60 Binary files /dev/null and b/docs/static/gitea-push-hint.png differ