diff options
| author | GitLab Bot <gitlab-bot@gitlab.com> | 2021-03-16 18:18:33 +0000 |
|---|---|---|
| committer | GitLab Bot <gitlab-bot@gitlab.com> | 2021-03-16 18:18:33 +0000 |
| commit | f64a639bcfa1fc2bc89ca7db268f594306edfd7c (patch) | |
| tree | a2c3c2ebcc3b45e596949db485d6ed18ffaacfa1 /doc/user/project/repository | |
| parent | bfbc3e0d6583ea1a91f627528bedc3d65ba4b10f (diff) | |
| download | gitlab-ce-f64a639bcfa1fc2bc89ca7db268f594306edfd7c.tar.gz | |
Add latest changes from gitlab-org/gitlab@13-10-stable-eev13.10.0-rc40
Diffstat (limited to 'doc/user/project/repository')
16 files changed, 184 insertions, 169 deletions
diff --git a/doc/user/project/repository/branches/img/branch_filter_search_box.png b/doc/user/project/repository/branches/img/branch_filter_search_box.png Binary files differdeleted file mode 100644 index 5dc300cf24e..00000000000 --- a/doc/user/project/repository/branches/img/branch_filter_search_box.png +++ /dev/null diff --git a/doc/user/project/repository/branches/img/branch_filter_search_box_v13_10.png b/doc/user/project/repository/branches/img/branch_filter_search_box_v13_10.png Binary files differnew file mode 100644 index 00000000000..da7d5268b3b --- /dev/null +++ b/doc/user/project/repository/branches/img/branch_filter_search_box_v13_10.png diff --git a/doc/user/project/repository/branches/img/compare_branches.png b/doc/user/project/repository/branches/img/compare_branches.png Binary files differdeleted file mode 100644 index e6f88da4989..00000000000 --- a/doc/user/project/repository/branches/img/compare_branches.png +++ /dev/null diff --git a/doc/user/project/repository/branches/img/compare_branches_v13_10.png b/doc/user/project/repository/branches/img/compare_branches_v13_10.png Binary files differnew file mode 100644 index 00000000000..2b9a5751938 --- /dev/null +++ b/doc/user/project/repository/branches/img/compare_branches_v13_10.png diff --git a/doc/user/project/repository/branches/img/repository_filter_search_box_v13_10.png b/doc/user/project/repository/branches/img/repository_filter_search_box_v13_10.png Binary files differnew file mode 100644 index 00000000000..fdda3858c3b --- /dev/null +++ b/doc/user/project/repository/branches/img/repository_filter_search_box_v13_10.png diff --git a/doc/user/project/repository/branches/index.md b/doc/user/project/repository/branches/index.md index 4d0cf28593d..d049b2108ee 100644 --- a/doc/user/project/repository/branches/index.md +++ b/doc/user/project/repository/branches/index.md @@ -64,7 +64,7 @@ against accidental deletion and forced pushes. By default, when you create a new project in GitLab, the initial branch is called `master`. For self-managed instances, a GitLab administrator can customize the initial branch name to something -else. This way, every new project created from then on will start from the custom branch name rather than `master`. To do so: +else. This way, every new project created from then on starts from the custom branch name rather than `master`. To do so: 1. Go to the **Admin Area > Settings > Repository** and expand **Default initial branch name**. @@ -96,10 +96,11 @@ To compare branches in a repository: 1. Navigate to your project's repository. 1. Select **Repository > Compare** in the sidebar. -1. Select branches to compare using the [branch filter search box](#branch-filter-search-box) +1. Select the target repository to compare with the [repository filter search box](#repository-filter-search-box). +1. Select branches to compare using the [branch filter search box](#branch-filter-search-box). 1. Click **Compare** to view the changes inline: - +  ## Delete merged branches @@ -108,17 +109,30 @@ To compare branches in a repository:  This feature allows merged branches to be deleted in bulk. Only branches that -have been merged and [are not protected](../../protected_branches.md) will be deleted as part of +have been merged and [are not protected](../../protected_branches.md) are deleted as part of this operation. It's particularly useful to clean up old branches that were not deleted automatically when a merge request was merged. +## Repository filter search box + +> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/52967) in GitLab 13.10. + +This feature allows you to search and select a repository quickly when [comparing branches](#compare). + + + +Search results appear in the following order: + +- Repositories with names exactly matching the search terms. +- Other repositories with names that include search terms, sorted alphabetically. + ## Branch filter search box > [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/22166) in GitLab 11.5. - + This feature allows you to search and select branches quickly. Search results appear in the following order: @@ -127,8 +141,8 @@ This feature allows you to search and select branches quickly. Search results ap Sometimes when you have hundreds of branches you may want a more flexible matching pattern. In such cases you can use the following: -- `^feature` will only match branch names that begin with 'feature'. -- `feature$` will only match branch names that end with 'feature'. +- `^feature` matches only branch names that begin with 'feature'. +- `feature$` matches only branch names that end with 'feature'. <!-- ## Troubleshooting diff --git a/doc/user/project/repository/file_finder.md b/doc/user/project/repository/file_finder.md index df3e24fbf30..3af7a5045c4 100644 --- a/doc/user/project/repository/file_finder.md +++ b/doc/user/project/repository/file_finder.md @@ -5,7 +5,7 @@ info: To determine the technical writer assigned to the Stage/Group associated w disqus_identifier: 'https://docs.gitlab.com/ee/workflow/file_finder.html' --- -# File finder +# File finder **(FREE)** > [Introduced](https://github.com/gitlabhq/gitlabhq/pull/9889) in GitLab 8.4. diff --git a/doc/user/project/repository/forking_workflow.md b/doc/user/project/repository/forking_workflow.md index 1a5e169ec6b..c8922890deb 100644 --- a/doc/user/project/repository/forking_workflow.md +++ b/doc/user/project/repository/forking_workflow.md @@ -31,25 +31,25 @@ Forking a project is, in most cases, a two-step process.  -The fork is created. The permissions you have in the namespace are the permissions you will have in the fork. +The fork is created. The permissions you have in the namespace are your permissions in the fork. WARNING: -When a public project with the repository feature set to "Members -only" is forked, the repository will be public in the fork. The owner -of the fork will need to manually change the visibility. This is being +When a public project with the repository feature set to **Members Only** +is forked, the repository is public in the fork. The owner +of the fork must manually change the visibility. This is being fixed in [#36662](https://gitlab.com/gitlab-org/gitlab/-/issues/36662). ## Repository mirroring You can use [repository mirroring](repository_mirroring.md) to keep your fork synced with the original repository. You can also use `git remote add upstream` to achieve the same result. -The main difference is that with repository mirroring your remote fork will be automatically kept up-to-date. +The main difference is that with repository mirroring, your remote fork is automatically kept up-to-date. -Without mirroring, to work locally you'll have to use `git pull` to update your local repository +Without mirroring, to work locally you must use `git pull` to update your local repository with the upstream project, then push the changes back to your fork to update it. WARNING: -With mirroring, before approving a merge request, you'll likely be asked to sync; hence automating it is recommended. +With mirroring, before approving a merge request, you are asked to sync. Because of this, automating it is recommended. Read more about [How to keep your fork up to date with its origin](https://about.gitlab.com/blog/2016/12/01/how-to-keep-your-fork-up-to-date-with-its-origin/). @@ -60,7 +60,7 @@ When you are ready to send your code back to the upstream project, choose your forked project's branch. For **Target branch**, choose the original project's branch. NOTE: -When creating a merge request, if the forked project's visibility is more restrictive than the parent project (for example the fork is private, the parent is public), the target branch will default to the forked project's default branch. This prevents potentially exposing the private code of the forked project. +When creating a merge request, if the forked project's visibility is more restrictive than the parent project (for example the fork is private, the parent is public), the target branch defaults to the forked project's default branch. This prevents potentially exposing the private code of the forked project.  diff --git a/doc/user/project/repository/git_blame.md b/doc/user/project/repository/git_blame.md index 81995291911..0f49932d0c6 100644 --- a/doc/user/project/repository/git_blame.md +++ b/doc/user/project/repository/git_blame.md @@ -18,13 +18,12 @@ You can find the **Blame** button with each file in a project.  -When you select the **Blame** button, you'll see a screen with the -noted information: +When you select the **Blame** button, this information is shown:  -If you hover over a commit in the UI, you'll see a precise date and time -for that commit. +If you hover over a commit in the UI, the commit's precise date and time +are shown. ## Blame previous commit @@ -45,7 +44,7 @@ about a `README.md` file in the local directory, run the following command: git blame README.md ``` -You'll see output similar to the following, which includes the commit time +The output looks similar to the following, which includes the commit time in UTC format: ```shell diff --git a/doc/user/project/repository/git_history.md b/doc/user/project/repository/git_history.md index 2e27cab4177..1b30a0b0f5f 100644 --- a/doc/user/project/repository/git_history.md +++ b/doc/user/project/repository/git_history.md @@ -17,13 +17,12 @@ You can find the **History** button with each file in a project.  -When you select the **History** button, you'll see a screen with the -noted information: +When you select the **History** button, this information displays:  -If you hover over a commit in the UI, you'll see a precise date and time -that commit was last modified. +If you hover over a commit in the UI, the precise date and time of the commit modification +are shown. ## Associated `git` command @@ -36,7 +35,7 @@ following command: git log README.md ``` -You'll see output similar to the following, which includes the commit +Git displays output similar to the following, which includes the commit time in UTC format: ```shell diff --git a/doc/user/project/repository/gpg_signed_commits/index.md b/doc/user/project/repository/gpg_signed_commits/index.md index 1a46c140507..c41b3ed8615 100644 --- a/doc/user/project/repository/gpg_signed_commits/index.md +++ b/doc/user/project/repository/gpg_signed_commits/index.md @@ -40,7 +40,7 @@ For a commit to be verified by GitLab: ## Generating a GPG key -If you don't already have a GPG key, the following steps will help you get +If you don't already have a GPG key, the following steps can help you get started: 1. [Install GPG](https://www.gnupg.org/download/index.html) for your operating system. @@ -225,8 +225,8 @@ git config --global commit.gpgsign true ## Verifying commits 1. Within a project or [merge request](../../merge_requests/index.md), navigate to - the **Commits** tab. Signed commits will show a badge containing either - "Verified" or "Unverified", depending on the verification status of the GPG + the **Commits** tab. Signed commits show a badge containing either + **Verified** or **Unverified**, depending on the verification status of the GPG signature.  @@ -240,8 +240,8 @@ git config --global commit.gpgsign true ## Revoking a GPG key Revoking a key **unverifies** already signed commits. Commits that were -verified by using this key will change to an unverified state. Future commits -will also stay unverified once you revoke this key. This action should be used +verified by using this key changes to an unverified state. Future commits +stay unverified after you revoke this key. This action should be used in case your key has been compromised. To revoke a GPG key: @@ -282,6 +282,7 @@ For more details about GPG, see: - [Managing OpenPGP Keys](https://riseup.net/en/security/message-security/openpgp/gpg-keys) - [OpenPGP Best Practices](https://riseup.net/en/security/message-security/openpgp/best-practices) - [Creating a new GPG key with subkeys](https://www.void.gr/kargig/blog/2013/12/02/creating-a-new-gpg-key-with-subkeys/) (advanced) +- [Review existing GPG keys in your instance](../../../admin_area/credentials_inventory.md#review-existing-gpg-keys) <!-- ## Troubleshooting diff --git a/doc/user/project/repository/index.md b/doc/user/project/repository/index.md index 5a915ebef89..b9145364e3b 100644 --- a/doc/user/project/repository/index.md +++ b/doc/user/project/repository/index.md @@ -19,8 +19,8 @@ To create a new repository, all you need to do is Once you create a new project, you can add new files via UI (read the section below) or via command line. -To add files from the command line, follow the instructions that will -be presented on the screen when you create a new project, or read +To add files from the command line, follow the instructions +presented on the screen when you create a new project, or read through them in the [command line basics](../../../gitlab-basics/start-using-git.md) documentation. @@ -31,8 +31,7 @@ that you [connect with GitLab via SSH](../../../ssh/README.md). ## Files Use a repository to store your files in GitLab. In [GitLab 12.10 and later](https://gitlab.com/gitlab-org/gitlab/-/issues/33806), -you'll see on the repository's file tree an icon next to the filename -according to its extension: +an icon identifying the extension is shown next to the filename:  @@ -76,7 +75,7 @@ markup languages](https://en.wikipedia.org/wiki/Lightweight_markup_language)) that you can use for the content of your files in a repository. They are mostly used for documentation purposes. -Just pick the right extension for your files and GitLab will render them +Just pick the right extension for your files and GitLab renders them according to the markup language. | Markup language | Extensions | @@ -93,7 +92,7 @@ according to the markup language. ### Repository README and index files -When a `README` or `index` file is present in a repository, its contents will be +When a `README` or `index` file is present in a repository, its contents are automatically pre-rendered by GitLab without opening it. They can either be plain text or have an extension of a @@ -101,12 +100,12 @@ They can either be plain text or have an extension of a Some things to note about precedence: -1. When both a `README` and an `index` file are present, the `README` will always - take precedence. +1. When both a `README` and an `index` file are present, the `README` always + takes precedence. 1. When more than one file is present with different extensions, they are - ordered alphabetically, with the exception of a file without an extension - which will always be last in precedence. For example, `README.adoc` will take - precedence over `README.md`, and `README.rst` will take precedence over + ordered alphabetically, with the exception of a file without an extension, + which is always last in precedence. For example, `README.adoc` takes + precedence over `README.md`, and `README.rst` takes precedence over `README`. ### Jupyter Notebook files @@ -159,18 +158,18 @@ Via command line, you can commit multiple times before pushing. - **Commit message:** A commit message is important to identity what is being changed and, more importantly, why. In GitLab, you can add keywords to the commit - message that will perform one of the actions below: + message that performs one of the actions below: - **Trigger a GitLab CI/CD pipeline:** If you have your project configured with [GitLab CI/CD](../../../ci/README.md), - you will trigger a pipeline per push, not per commit. + you trigger a pipeline per push, not per commit. - **Skip pipelines:** - You can add to you commit message the keyword - [`[ci skip]`](../../../ci/yaml/README.md#skip-pipeline) - and GitLab CI/CD will skip that pipeline. + You can add to your commit message the keyword + [`[ci skip]`](../../../ci/yaml/README.md#skip-pipeline), + and GitLab CI/CD skips that pipeline. - **Cross-link issues and merge requests:** [Cross-linking](../issues/crosslinking_issues.md#from-commit-messages) is great to keep track of what's is somehow related in your workflow. - If you mention an issue or a merge request in a commit message, they will be shown + If you mention an issue or a merge request in a commit message, they are shown on their respective thread. - **Cherry-pick a commit:** In GitLab, you can @@ -211,9 +210,9 @@ Find it under your project's **Repository > Graph**. ## Repository Languages -For the default branch of each repository, GitLab will determine what programming languages -were used and display this on the projects pages. If this information is missing, it will -be added after updating the default branch on the project. This process can take up to 5 +For the default branch of each repository, GitLab determines what programming languages +were used and displays this on the project's pages. If this information is missing, it's +added after updating the default branch for the project. This process can take up to five minutes.  @@ -253,8 +252,8 @@ into Xcode on macOS. To do that: 1. Click **Clone**. 1. Select **Xcode**. -The project will be cloned onto your computer in a folder of your choice and you'll -be prompted to open in XCode. +The project is cloned onto your computer in a folder of your choice and you are +prompted to open XCode. ### Clone and open in Visual Studio Code @@ -264,10 +263,10 @@ All projects can be cloned into Visual Studio Code. To do that: 1. From the GitLab UI, go to the project's overview page. 1. Click **Clone**. -1. Select **VS Code** +1. Select **VS Code**. +1. Select a folder to clone the project into. -You'll be prompted to select a folder to clone the project into. When VS Code has -successfully cloned your project, it will open the folder. +When VS Code has successfully cloned your project, it opens the folder. ## Download Source Code @@ -275,7 +274,7 @@ successfully cloned your project, it will open the folder. > - Support for [including Git LFS blobs](../../../topics/git/lfs#lfs-objects-in-project-archives) was [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/15079) in GitLab 13.5. The source code stored in a repository can be downloaded from the UI. -By clicking the download icon, a dropdown will open with links to download the following: +By clicking the download icon, a dropdown opens with links to download the following:  @@ -297,8 +296,8 @@ and Git push/pull redirects. Depending on the situation, different things apply. -When [renaming a user](../../profile/index.md#changing-your-username), -[changing a group path](../../group/index.md#changing-a-groups-path) or [renaming a repository](../settings/index.md#renaming-a-repository): +When [renaming a user](../../profile/index.md#change-your-username), +[changing a group path](../../group/index.md#change-a-groups-path) or [renaming a repository](../settings/index.md#renaming-a-repository): - Existing web URLs for the namespace and anything under it (such as projects) will redirect to the new URLs. diff --git a/doc/user/project/repository/jupyter_notebooks/index.md b/doc/user/project/repository/jupyter_notebooks/index.md index 123df9097f9..e4a3e6d6ef1 100644 --- a/doc/user/project/repository/jupyter_notebooks/index.md +++ b/doc/user/project/repository/jupyter_notebooks/index.md @@ -12,12 +12,12 @@ type: reference interactive computing in many fields and contain a complete record of the user's sessions and include code, narrative text, equations, and rich output. -When added to a repository, Jupyter Notebooks with a `.ipynb` extension will be +When added to a repository, Jupyter Notebooks with a `.ipynb` extension are rendered to HTML when viewed.  -Interactive features, including JavaScript plots, will not work when viewed in +Interactive features, including JavaScript plots, don't work when viewed in GitLab. ## Jupyter Hub as a GitLab Managed App diff --git a/doc/user/project/repository/repository_mirroring.md b/doc/user/project/repository/repository_mirroring.md index 4d5e4a5ef02..980c5417da6 100644 --- a/doc/user/project/repository/repository_mirroring.md +++ b/doc/user/project/repository/repository_mirroring.md @@ -7,19 +7,19 @@ disqus_identifier: 'https://docs.gitlab.com/ee/workflow/repository_mirroring.htm # Repository mirroring **(FREE)** -Repository mirroring allows for mirroring of repositories to and from external sources. It can be -used to mirror branches, tags, and commits between repositories. It is useful when you want to use +Repository mirroring allows for the mirroring of repositories to and from external sources. You +can use it to mirror branches, tags, and commits between repositories. It's useful when you want to use a repository outside of GitLab. -A repository mirror at GitLab will be updated automatically. You can also manually trigger an update -at most once every 5 minutes on GitLab.com with [the limit set by the administrator on self-managed instances](../../../administration/instance_limits.md#pull-mirroring-interval). +A repository mirror at GitLab updates automatically. You can also manually trigger an update +at most once every five minutes on GitLab.com with [the limit set by the administrator on self-managed instances](../../../administration/instance_limits.md#pull-mirroring-interval). There are two kinds of repository mirroring supported by GitLab: - [Push](#pushing-to-a-remote-repository): for mirroring a GitLab repository to another location. **(FREE)** - [Pull](#pulling-from-a-remote-repository): for mirroring a repository from another location to GitLab. **(PREMIUM)** -When the mirror repository is updated, all new branches, tags, and commits will be visible in the +When the mirror repository is updated, all new branches, tags, and commits are visible in the project's activity feed. Users with at least [Developer access](../../permissions.md) to the project can also force an @@ -37,7 +37,7 @@ The following are some possible use cases for repository mirroring: - You migrated to GitLab but still need to keep your project in another source. In that case, you can simply set it up to mirror to GitLab (pull) and all the essential history of commits, tags, - and branches will be available in your GitLab instance. **(PREMIUM)** + and branches are available in your GitLab instance. **(PREMIUM)** - You have old projects in another source that you don't use actively anymore, but don't want to remove for archiving purposes. In that case, you can create a push mirror so that your active GitLab repository can push its changes to the old location. @@ -49,25 +49,23 @@ The following are some possible use cases for repository mirroring: ## Pushing to a remote repository **(FREE)** -> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/249) in GitLab Enterprise Edition 8.7. -> - [Moved to GitLab Free](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/18715) in 10.8. -> - [LFS support over HTTPS added](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/40137) in 13.5 +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/40137) in GitLab 13.5: LFS support over HTTPS. For an existing project, you can set up push mirroring as follows: -1. Navigate to your project's **Settings > Repository** and expand the **Mirroring repositories** section. +1. In your project, go to **Settings > Repository**, and then expand the **Mirroring repositories** section. 1. Enter a repository URL. -1. Select **Push** from the **Mirror direction** dropdown. +1. In the **Mirror direction** dropdown, select **Push**. 1. Select an authentication method from the **Authentication method** dropdown. You can authenticate with either a password or an [SSH key](#ssh-authentication). -1. Check the **Only mirror protected branches** box, if necessary. -1. Check the **Keep divergent refs** box, if desired. -1. Click the **Mirror repository** button to save the configuration. +1. Select the **Only mirror protected branches** check box, if necessary. +1. Select the **Keep divergent refs** check box, if desired. +1. Select **Mirror repository** to save the configuration.  When push mirroring is enabled, only push commits directly to the mirrored repository to prevent the -mirror diverging. All changes will end up in the mirrored repository whenever: +mirror diverging. The mirrored repository receives all changes when: - Commits are pushed to GitLab. - A [forced update](#forcing-an-update) is initiated. @@ -77,7 +75,7 @@ Changes pushed to files in the repository are automatically pushed to the remote - Within five minutes of being received. - Within one minute if **Only mirror protected branches** is enabled. -In the case of a diverged branch, you will see an error indicated at the **Mirroring repositories** +In the case of a diverged branch, an error displays in the **Mirroring repositories** section. ### Configuring push mirrors through the API @@ -87,20 +85,20 @@ You can also create and modify project push mirrors through the ### Keep divergent refs -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/208828) in GitLab 13.0. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/208828) in GitLab 13.0. By default, if any ref on the remote mirror has diverged from the local -repository, the *entire push* will fail, and nothing will be updated. +repository, the *entire push* fails, and no updates occur. For example, if a repository has `master`, `develop`, and `stable` branches that have been mirrored to a remote, and then a new commit is added to `develop` on -the mirror, the next push attempt will fail, leaving `master` and `stable` +the mirror, the next push attempt fails, leaving `master` and `stable` out-of-date despite not having diverged. No change on any branch can be mirrored until the divergence is resolved. With the **Keep divergent refs** option enabled, the `develop` branch is -skipped, allowing `master` and `stable` to be updated. The mirror status will -reflect that `develop` has diverged and was skipped, and be marked as a failed +skipped, allowing `master` and `stable` to be updated. The mirror status +reflects that `develop` has diverged and was skipped, and be marked as a failed update. NOTE: @@ -110,18 +108,18 @@ After the mirror is created, this option can currently only be modified via the To set up a mirror from GitLab to GitHub, you need to follow these steps: -1. Create a [GitHub personal access token](https://docs.github.com/en/free-pro-team@latest/github/authenticating-to-github/creating-a-personal-access-token) with the `public_repo` box checked. +1. Create a [GitHub personal access token](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token) with the `public_repo` box checked. 1. Fill in the **Git repository URL** field using this format: `https://<your_github_username>@github.com/<your_github_group>/<your_github_project>.git`. 1. Fill in **Password** field with your GitHub personal access token. -1. Click the **Mirror repository** button. +1. Select **Mirror repository**. -The mirrored repository will be listed. For example, `https://*****:*****@github.com/<your_github_group>/<your_github_project>.git`. +The mirrored repository is listed. For example, `https://*****:*****@github.com/<your_github_group>/<your_github_project>.git`. -The repository will push soon. To force a push, click the **Update now** (**{retry}**) button. +The repository pushes shortly thereafter. To force a push, select the **Update now** (**{retry}**) button. ### Setting up a push mirror from GitLab to AWS CodeCommit -AWS CodeCommit push mirroring is currently the best way to connect GitLab repositories to AWS CodePipeline, as GitLab is not yet supported as one of their Source Code Management (SCM) providers. +AWS CodeCommit push mirroring is currently the best way to connect GitLab repositories to AWS CodePipeline, as GitLab isn't yet supported as one of their Source Code Management (SCM) providers. Each new AWS CodePipeline needs significant AWS infrastructure setup. It also requires an individual pipeline per branch. @@ -159,9 +157,9 @@ To set up a mirror from GitLab to AWS CodeCommit: } ``` -1. After the user was created, click the AWS IAM user name. -1. Click the **Security credentials** tab. -1. Under **HTTPS Git credentials for AWS CodeCommit** click **Generate credentials**. +1. After the user was created, select the AWS IAM user name. +1. Select the **Security credentials** tab. +1. Under **HTTPS Git credentials for AWS CodeCommit** select **Generate credentials**. NOTE: This Git user ID and password is specific to communicating with CodeCommit. Do @@ -169,9 +167,9 @@ To set up a mirror from GitLab to AWS CodeCommit: 1. Copy or download special Git HTTPS user ID and password. 1. In the AWS CodeCommit console, create a new repository to mirror from your GitLab repository. -1. Open your new repository and click **Clone URL > Clone HTTPS** (not **Clone HTTPS (GRC)**). +1. Open your new repository, and then select **Clone URL > Clone HTTPS** (not **Clone HTTPS (GRC)**). 1. In GitLab, open the repository to be push-mirrored. -1. Click **Settings > Repository** and expand **Mirroring repositories**. +1. Go to **Settings > Repository**, and then expand **Mirroring repositories**. 1. Fill in the **Git repository URL** field using this format: ```plaintext @@ -185,17 +183,17 @@ To set up a mirror from GitLab to AWS CodeCommit: 1. For **Authentication method**, select **Password** and fill in the **Password** field with the special IAM Git clone user ID **password** created earlier in AWS. 1. The option **Only mirror protected branches** should be good for CodeCommit as it pushes more frequently (from every five minutes to every minute). - CodePipeline requires individual pipeline setups for named branches you wish to have a AWS CI setup for. Since feature branches that have dynamic names will not be supported anyway, configuring **Only mirror protected branches** does not cause flexibility problems with CodePipeline integration as long as you are also willing to protect all the named branches you want to build CodePipelines for. + CodePipeline requires individual pipeline setups for named branches you wish to have a AWS CI setup for. Because feature branches that have dynamic names are unsupported, configuring **Only mirror protected branches** doesn't cause flexibility problems with CodePipeline integration as long as you are also willing to protect all the named branches you want to build CodePipelines for. -1. Click **Mirror repository**. You should see the mirrored repository appear: +1. Select **Mirror repository**. You should see the mirrored repository appear: ```plaintext https://*****:*****@git-codecommit.<aws-region>.amazonaws.com/v1/repos/<your_codecommit_repo> ``` -To test mirroring by forcing a push, click the half-circle arrows button (hover text is **Update now**). +To test mirroring by forcing a push, select the half-circle arrows button (hover text is **Update now**). If **Last successful update** shows a date, you have configured mirroring correctly. -If it is not working correctly a red `error` tag appears and shows the error message as hover text. +If it isn't working correctly, a red `error` tag appears and shows the error message as hover text. ### Setting up a push mirror to another GitLab instance with 2FA activated @@ -203,11 +201,10 @@ If it is not working correctly a red `error` tag appears and shows the error mes 1. On the source GitLab instance: 1. Fill in the **Git repository URL** field using this format: `https://oauth2@<destination host>/<your_gitlab_group_or_name>/<your_gitlab_project>.git`. 1. Fill in the **Password** field with the GitLab personal access token created on the destination GitLab instance. - 1. Click the **Mirror repository** button. + 1. Select **Mirror repository**. ## Pulling from a remote repository **(PREMIUM)** -> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/51) in GitLab Enterprise Edition 8.2. > - [Added Git LFS support](https://gitlab.com/gitlab-org/gitlab/-/issues/10871) in GitLab 11.11. > - Moved to GitLab Premium in 13.9. @@ -219,16 +216,20 @@ to be able to browse its content and its activity using the familiar GitLab inte To configure mirror pulling for an existing project: -1. Navigate to your project's **Settings > Repository** and expand the **Mirroring repositories** - section. -1. Enter a repository URL. -1. Select **Pull** from the **Mirror direction** dropdown. -1. Select an authentication method from the **Authentication method** dropdown, if necessary. -1. If necessary, check the following boxes: - - **Overwrite diverged branches**. - - **Trigger pipelines for mirror updates**. - - **Only mirror protected branches**. -1. Click the **Mirror repository** button to save the configuration. +1. If you [configured two-factor authentication (2FA)](https://docs.github.com/en/github/authenticating-to-github/securing-your-account-with-two-factor-authentication-2fa) + for GitHub, create a [personal access token for GitHub](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token) + with the `read_repository` scope. If 2FA is enabled, this personal access + token serves as your GitHub password. +1. In your project, go to **Settings > Repository**, and then expand the + **Mirroring repositories** section. +1. In the **Git repository URL** field, enter a repository URL. +1. In the **Mirror direction** dropdown, select **Pull**. +1. In the **Authentication method** dropdown, select your authentication method. +1. Select from the following checkboxes, if needed: + - **Overwrite diverged branches** + - **Trigger pipelines for mirror updates** + - **Only mirror protected branches** +1. Select **Mirror repository** to save the configuration.  @@ -238,15 +239,15 @@ To configure mirror pulling for an existing project: Because GitLab is now set to pull changes from the upstream repository, you should not push commits directly to the repository on GitLab. Instead, any commits should be pushed to the remote repository. -Changes pushed to the remote repository will be pulled into the GitLab repository, either: +Changes pushed to the remote repository are pulled into the GitLab repository, either: - Automatically within a certain period of time. - When a [forced update](#forcing-an-update) is initiated. WARNING: -If you do manually update a branch in the GitLab repository, the branch will become diverged from -upstream and GitLab will no longer automatically update this branch to prevent any changes from being lost. -Also note that deleted branches and tags in the upstream repository will not be reflected in the GitLab repository. +If you do manually update a branch in the GitLab repository, the branch becomes diverged from +upstream, and GitLab no longer automatically updates this branch to prevent any changes from being lost. +Deleted branches and tags in the upstream repository are not reflected in the GitLab repository. ### How it works @@ -259,13 +260,12 @@ Once per minute, a Sidekiq cron job schedules repository mirrors to update, base Repository mirrors are updated as Sidekiq becomes available to process them. If the process of updating the repository mirror: -- Succeeds, an update will be enqueued again with at least a 30 minute wait. -- Fails (for example, a branch diverged from upstream), it will be attempted again later. Mirrors can fail - up to 14 times before they will not be enqueued for update again. +- **Succeeds**: An update is enqueued again with at least a 30 minute wait. +- **Fails**: (For example, a branch diverged from upstream.), The update attempted again later. Mirrors can fail + up to 14 times before they are no longer enqueued for updates. ### Overwrite diverged branches **(PREMIUM)** -> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/4559) in GitLab 10.6. > - Moved to GitLab Premium in 13.9. You can choose to always update your local branches with remote versions, even if they have @@ -278,42 +278,39 @@ To use this option, check the **Overwrite diverged branches** box when creating ### Trigger pipelines for mirror updates **(PREMIUM)** -> Moved to GitLab Premium in 13.9. +> - Moved to GitLab Premium in 13.9. -If this option is enabled, pipelines will be triggered when branches or tags are +If this option is enabled, pipelines trigger when branches or tags are updated from the remote repository. Depending on the activity of the remote repository, this may greatly increase the load on your CI runners. Only enable -this if you know they can handle the load. CI will run using the credentials +this if you know they can handle the load. CI uses the credentials assigned when you set up pull mirroring. ### Hard failure **(PREMIUM)** -> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/3117) in GitLab 10.2. > - Moved to GitLab Premium in 13.9. -Once the mirroring process is unsuccessfully retried 14 times in a row, it will get marked as hard -failed. This will become visible in either the: +After 14 consecutive unsuccessful retries, the mirroring process is marked as a hard failure +and mirroring attempts stop. This failure is visible in either the: - Project's main dashboard. - Pull mirror settings page. -When a project is hard failed, it will no longer get picked up for mirroring. You can resume the project mirroring again by [forcing an update](#forcing-an-update). ### Trigger an update using the API **(PREMIUM)** -> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/3453) in GitLab 10.3. > - Moved to GitLab Premium in 13.9. Pull mirroring uses polling to detect new branches and commits added upstream, often minutes afterwards. If you notify GitLab by [API](../../../api/projects.md#start-the-pull-mirroring-process-for-a-project), -updates will be pulled immediately. +updates are pulled immediately. For more information, see [Start the pull mirroring process for a Project](../../../api/projects.md#start-the-pull-mirroring-process-for-a-project). ## Mirror only protected branches **(PREMIUM)** -> Moved to GitLab Premium in 13.9. +> - Moved to GitLab Premium in 13.9. Based on the mirror direction that you choose, you can opt to mirror only the [protected branches](../protected_branches.md) from/to your remote repository. @@ -324,7 +321,6 @@ creating a repository mirror. **(PREMIUM)** ## SSH authentication -> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/2551) in GitLab 9.5 for Pull mirroring. > - [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/22982) in GitLab 11.6 for Push mirroring. SSH authentication is mutual: @@ -336,15 +332,15 @@ You provide your credentials as a password or public key. The server that the other repository resides on provides its credentials as a "host key", the fingerprint of which needs to be verified manually. -If you're mirroring over SSH (that is, using an `ssh://` URL), you can authenticate using: +If you're mirroring over SSH (using an `ssh://` URL), you can authenticate using: - Password-based authentication, just as over HTTPS. - Public key authentication. This is often more secure than password authentication, - especially when the other repository supports [deploy keys](../../../ssh/README.md#deploy-keys). + especially when the other repository supports [deploy keys](../deploy_keys/index.md). To get started: -1. Navigate to your project's **Settings > Repository** and expand the **Mirroring repositories** section. +1. In your project, go to **Settings > Repository**, and then expand the **Mirroring repositories** section. 1. Enter an `ssh://` URL for mirroring. NOTE: @@ -355,9 +351,9 @@ Entering the URL adds two buttons to the page: - **Detect host keys**. - **Input host keys manually**. -If you click the: +If you select the: -- **Detect host keys** button, GitLab will fetch the host keys from the server and display the fingerprints. +- **Detect host keys** button, GitLab fetches the host keys from the server and display the fingerprints. - **Input host keys manually** button, a field is displayed where you can paste in host keys. Assuming you used the former, you now need to verify that the fingerprints are @@ -366,13 +362,13 @@ fingerprints in the open for you to check: - [AWS CodeCommit](https://docs.aws.amazon.com/codecommit/latest/userguide/regions.html#regions-fingerprints) - [Bitbucket](https://support.atlassian.com/bitbucket-cloud/docs/configure-ssh-and-two-step-verification/) -- [GitHub](https://docs.github.com/en/free-pro-team@latest/github/authenticating-to-github/githubs-ssh-key-fingerprints) +- [GitHub](https://docs.github.com/en/github/authenticating-to-github/githubs-ssh-key-fingerprints) - [GitLab.com](../../gitlab_com/index.md#ssh-host-keys-fingerprints) - [Launchpad](https://help.launchpad.net/SSHFingerprints) - [Savannah](http://savannah.gnu.org/maintenance/SshAccess/) - [SourceForge](https://sourceforge.net/p/forge/documentation/SSH%20Key%20Fingerprints/) -Other providers will vary. If you're running self-managed GitLab, or otherwise +Other providers vary. If you're running self-managed GitLab, or otherwise have access to the server for the other repository, you can securely gather the key fingerprints: @@ -386,28 +382,28 @@ $ cat /etc/ssh/ssh_host*pub | ssh-keygen -E md5 -l -f - NOTE: You may need to exclude `-E md5` for some older versions of SSH. -When mirroring the repository, GitLab will now check that at least one of the +When mirroring the repository, GitLab checks that at least one of the stored host keys matches before connecting. This can prevent malicious code from being injected into your mirror, or your password being stolen. ### SSH public key authentication -To use SSH public key authentication, you'll also need to choose that option +To use SSH public key authentication, you must also choose that option from the **Authentication method** dropdown. When the mirror is created, -GitLab generates a 4096-bit RSA key that can be copied by clicking the **Copy SSH public key** button. +GitLab generates a 4096-bit RSA key that can be copied by selecting the **Copy SSH public key** button.  You then need to add the public SSH key to the other repository's configuration: - If the other repository is hosted on GitLab, you should add the public SSH key - as a [deploy key](../../../ssh/README.md#deploy-keys). + as a [deploy key](../../project/deploy_keys/index.md). - If the other repository is hosted elsewhere, you may need to add the key to your user's `authorized_keys` file. Paste the entire public SSH key into the file on its own line and save it. If you need to change the key at any time, you can remove and re-add the mirror -to generate a new key. You'll have to update the other repository with the new +to generate a new key. Update the other repository with the new key to keep the mirror running. NOTE: @@ -423,17 +419,17 @@ update button which is available on the **Mirroring repositories** section of th ## Bidirectional mirroring **(PREMIUM)** -> Moved to GitLab Premium in 13.9. +> - Moved to GitLab Premium in 13.9. WARNING: Bidirectional mirroring may cause conflicts. If you configure a GitLab repository to both pull from, and push to, the same remote source, there -is no guarantee that either repository will update correctly. If you set up a repository for -bidirectional mirroring, you should prepare for the likely conflicts by deciding who will resolve -them and how they will be resolved. +is no guarantee that either repository updates correctly. If you set up a repository for +bidirectional mirroring, you should prepare for the likely conflicts by deciding who resolves +them and how. -Rewriting any mirrored commit on either remote will cause conflicts and mirroring to fail. This can +Rewriting any mirrored commit on either remote causes conflicts and mirroring to fail. This can be prevented by [mirroring only protected branches](#mirror-only-protected-branches). You should [protect the branches](../protected_branches.md) you wish to mirror on both @@ -447,34 +443,35 @@ protected branches. ### Configure a webhook to trigger an immediate pull to GitLab -Assuming you have already configured the [push](#setting-up-a-push-mirror-to-another-gitlab-instance-with-2fa-activated) and [pull](#pulling-from-a-remote-repository) mirrors in the upstream GitLab instance, to trigger an immediate pull as suggested above, you will need to configure a [Push Event Web Hook](../integrations/webhooks.md#push-events) in the downstream instance. +Assuming you have already configured the [push](#setting-up-a-push-mirror-to-another-gitlab-instance-with-2fa-activated) and [pull](#pulling-from-a-remote-repository) mirrors in the upstream GitLab instance, to trigger an immediate pull as suggested above, you must configure a [Push Event Web Hook](../integrations/webhooks.md#push-events) in the downstream instance. To do this: -- Create a [personal access token](../../profile/personal_access_tokens.md) with `API` scope. -- Navigate to **Settings > Webhooks** -- Add the webhook URL which in this case will use the [Pull Mirror API](../../../api/projects.md#start-the-pull-mirroring-process-for-a-project) request to trigger an immediate pull after updates to the repository. +1. Create a [personal access token](../../profile/personal_access_tokens.md) with `API` scope. +1. In your project, go to **Settings > Webhooks**. +1. Add the webhook URL which (in this case) uses the [Pull Mirror API](../../../api/projects.md#start-the-pull-mirroring-process-for-a-project) request to trigger an immediate pull after updates to the repository. - ```plaintext - https://gitlab.example.com/api/v4/projects/:id/mirror/pull?private_token=<your_access_token> - ``` + ```plaintext + https://gitlab.example.com/api/v4/projects/:id/mirror/pull?private_token=<your_access_token> + ``` + +1. Ensure the **Push Events** checkbox is selected. +1. Select **Add Webhook** to save the webhook. -- Ensure that the **Push Events** checkbox is selected. -- Click on **Add Webhook** button to save the webhook. -- To test the integration click on the **Test** button and confirm GitLab does not return any error. +To test the integration, select the **Test** button and confirm GitLab doesn't return an error message. ### Preventing conflicts using a `pre-receive` hook WARNING: -The solution proposed will negatively impact the performance of -Git push operations because they will be proxied to the upstream Git +The solution proposed negatively affects the performance of +Git push operations because they are proxied to the upstream Git repository. A server-side `pre-receive` hook can be used to prevent the race condition described above by only accepting the push after first pushing the commit to the upstream Git repository. In this configuration one Git repository acts as the authoritative upstream, and the other as downstream. The `pre-receive` hook -will be installed on the downstream repository. +is installed on the downstream repository. Read about [configuring Server hooks](../../../administration/server_hooks.md) on the GitLab server. @@ -540,11 +537,11 @@ fi Note that this sample has a few limitations: - This example may not work verbatim for your use case and might need modification. - - It does not regard different types of authentication mechanisms for the mirror. - - It does not work with forced updates (rewriting history). - - Only branches that match the `allowlist` patterns will be proxy pushed. + - It doesn't regard different types of authentication mechanisms for the mirror. + - It doesn't work with forced updates (rewriting history). + - Only branches that match the `allowlist` patterns are proxy pushed. - The script circumvents the Git hook quarantine environment because the update of `$TARGET_REPO` - is seen as a ref update and Git will complain about it. + is seen as a ref update, and Git displays warnings about it. ### Mirroring with Perforce Helix via Git Fusion **(PREMIUM)** @@ -560,22 +557,22 @@ mirror projects with GitLab. This may be useful in some situations when migratin to GitLab where overlapping Perforce Helix workspaces cannot be migrated simultaneously to GitLab. If using mirroring with Perforce Helix, you should only mirror protected branches. Perforce Helix -will reject any pushes that rewrite history. Only the fewest number of branches should be mirrored +rejects any pushes that rewrite history. Only the fewest number of branches should be mirrored due to the performance limitations of Git Fusion. When configuring mirroring with Perforce Helix via Git Fusion, the following Git Fusion settings are recommended: -- `change-pusher` should be disabled. Otherwise, every commit will be rewritten as being committed +- `change-pusher` should be disabled. Otherwise, every commit is rewritten as being committed by the mirroring account, rather than being mapped to existing Perforce Helix users or the `unknown_git` user. -- `unknown_git` user will be used as the commit author if the GitLab user does not exist in +- `unknown_git` user is used as the commit author if the GitLab user doesn't exist in Perforce Helix. Read about [Git Fusion settings on Perforce.com](https://www.perforce.com/manuals/git-fusion/Content/Git-Fusion/section_vss_bdw_w3.html#section_zdp_zz1_3l). ## Troubleshooting -Should an error occur during a push, GitLab will display an "Error" highlight for that repository. Details on the error can then be seen by hovering over the highlight text. +Should an error occur during a push, GitLab displays an **Error** highlight for that repository. Details on the error can then be seen by hovering over the highlight text. ### 13:Received RST_STREAM with error code 2 with GitHub @@ -584,3 +581,9 @@ If you receive an "13:Received RST_STREAM with error code 2" while mirroring to ### 4:Deadline Exceeded When upgrading to GitLab 11.11.8 or newer, a change in how usernames are represented means that you may need to update your mirroring username and password to ensure that `%40` characters are replaced with `@`. + +### Connection blocked because server only allows public key authentication + +As the error indicates, the connection is getting blocked between GitLab and the remote repository. Even if a [TCP Check](../../../administration/raketasks/maintenance.md#check-tcp-connectivity-to-a-remote-site) is successful, you must check any networking components in the route from GitLab to the remote Server to ensure there's no blockage. + +For example, we've seen this error when a Firewall was performing a `Deep SSH Inspection` on outgoing packets. diff --git a/doc/user/project/repository/web_editor.md b/doc/user/project/repository/web_editor.md index a9e249bb8c3..efa35c1ceac 100644 --- a/doc/user/project/repository/web_editor.md +++ b/doc/user/project/repository/web_editor.md @@ -5,7 +5,7 @@ info: To determine the technical writer assigned to the Stage/Group associated w type: howto --- -# GitLab Web Editor +# GitLab Web Editor **(FREE)** Sometimes it's easier to make quick changes directly from the GitLab interface than to clone the project and use the Git command-line tool. In this feature @@ -108,7 +108,7 @@ You can see a **Create merge request** dropdown below the issue description. The **Create merge request** button doesn't display if: - A branch with the same name already exists. -- The branch already has a referenced merge request. +- A merge request already exists for this branch. - Your project has an active fork relationship. To make this button appear, one possible workaround is to diff --git a/doc/user/project/repository/x509_signed_commits/index.md b/doc/user/project/repository/x509_signed_commits/index.md index 29c1c32145d..c89f3a267ba 100644 --- a/doc/user/project/repository/x509_signed_commits/index.md +++ b/doc/user/project/repository/x509_signed_commits/index.md @@ -39,7 +39,7 @@ recommend using certificates from a PKI that are in line with ## Obtaining an X.509 key pair -If your organization has Public Key Infrastructure (PKI), that PKI will provide +If your organization has Public Key Infrastructure (PKI), that PKI provides an S/MIME key. If you do not have an S/MIME key pair from a PKI, you can either create your @@ -49,7 +49,7 @@ and some of them generate keys for free. ## Associating your X.509 certificate with Git -To take advantage of X.509 signing, you will need Git 2.19.0 or later. You can +To take advantage of X.509 signing, you need Git 2.19.0 or later. You can check your Git version with: ```shell |
