Forgejo/docs/content/doc/usage/push.en-us.md
John Olheiser bb25f85ce8
Refactor docs (#23752)
This was intended to be a small followup for
https://github.com/go-gitea/gitea/pull/23712, but...here we are.

1. Our docs currently use `slug` as the entire URL, which makes
refactoring tricky (see https://github.com/go-gitea/gitea/pull/23712).
Instead, this PR attempts to make future refactoring easier by using
slugs as an extension of the section. (Hugo terminology)
- What the above boils down to is this PR attempts to use directory
organization as URL management. e.g. `usage/comparison.en-us.md` ->
`en-us/usage/comparison/`, `usage/packages/overview.en-us.md` ->
`en-us/usage/packages/overview/`
- Technically we could even remove `slug`, as Hugo defaults to using
filename, however at least with this PR it means `slug` only needs to be
the name for the **current file** rather than an entire URL
2. This PR adds appropriate aliases (redirects) for pages, so anything
on the internet that links to our docs should hopefully not break.
3. A minor nit I've had for a while, renaming `seek-help` to `support`.
It's a minor thing, but `seek-help` has a strange connotation to it.
4. The commits are split such that you can review the first which is the
"actual" change, and the second is added redirects so that the first
doesn't break links elsewhere.

---------

Signed-off-by: jolheiser <john.olheiser@gmail.com>
2023-04-28 11:33:41 +08:00

2.5 KiB

date title slug weight toc draft aliases menu
2020-07-06T16:00:00+02:00 Usage: Push push 15 false false
/en-us/push-to-create
/en-us/push-options
sidebar
parent name weight identifier
usage Push 15 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

Push Options

In Gitea 1.13, support for some push options 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:

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.en-us.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:

# 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.

Push-to-create will default to the visibility defined by DEFAULT_PUSH_CREATE_PRIVATE in app.ini.