diff options
author | GitLab Bot <gitlab-bot@gitlab.com> | 2023-05-25 21:09:47 +0300 |
---|---|---|
committer | GitLab Bot <gitlab-bot@gitlab.com> | 2023-05-25 21:09:47 +0300 |
commit | 99a6475e08172adc2c300273e81fccb04b0a8b0e (patch) | |
tree | 10a4c856ae83546ebe2c9fae2c3b3fb1236acd5a /doc/user/project | |
parent | d1c0c1c4c3241eae6795562d8a0c22def6771238 (diff) |
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc/user/project')
20 files changed, 43 insertions, 32 deletions
diff --git a/doc/user/project/deploy_keys/index.md b/doc/user/project/deploy_keys/index.md index 13ee07097e1..f7dc8079af8 100644 --- a/doc/user/project/deploy_keys/index.md +++ b/doc/user/project/deploy_keys/index.md @@ -160,7 +160,7 @@ There are a few scenarios where a deploy key fails to push to a - The owner associated to a deploy key does not have access to the protected branch. - The owner associated to a deploy key does not have [membership](../members/index.md) to the project of the protected branch. -- **No one** is selected in [the **Allowed to push and merge** section](../protected_branches.md#configure-a-protected-branch) of the protected branch. +- **No one** is selected in [the **Allowed to push and merge** section](../protected_branches.md#add-protection-to-existing-branches) of the protected branch. All deploy keys are associated to an account. Since the permissions for an account can change, this might lead to scenarios where a deploy key that was working is suddenly unable to push to a protected branch. diff --git a/doc/user/project/import/github.md b/doc/user/project/import/github.md index 068663af0c9..118e7caf123 100644 --- a/doc/user/project/import/github.md +++ b/doc/user/project/import/github.md @@ -282,11 +282,11 @@ When they are imported, supported GitHub branch protection rules are mapped to e | GitHub rule | GitLab rule | Introduced in | | :---------------------------------------------------------------------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------- | :------------------------------------------------------------------ | | **Require conversation resolution before merging** for the project's default branch | **All threads must be resolved** [project setting](../../discussions/index.md#prevent-merge-unless-all-threads-are-resolved) | [GitLab 15.5](https://gitlab.com/gitlab-org/gitlab/-/issues/371110) | -| **Require a pull request before merging** | **No one** option in the **Allowed to push and merge** list of [branch protection settings](../protected_branches.md#configure-a-protected-branch) | [GitLab 15.5](https://gitlab.com/gitlab-org/gitlab/-/issues/370951) | +| **Require a pull request before merging** | **No one** option in the **Allowed to push and merge** list of [branch protection settings](../protected_branches.md#add-protection-to-existing-branches) | [GitLab 15.5](https://gitlab.com/gitlab-org/gitlab/-/issues/370951) | | **Require signed commits** for the project's default branch | **Reject unsigned commits** GitLab [push rule](../repository/push_rules.md#prevent-unintended-consequences) **(PREMIUM)** | [GitLab 15.5](https://gitlab.com/gitlab-org/gitlab/-/issues/370949) | | **Allow force pushes - Everyone** | **Allowed to force push** [branch protection setting](../protected_branches.md#allow-force-push-on-a-protected-branch) | [GitLab 15.6](https://gitlab.com/gitlab-org/gitlab/-/issues/370943) | | **Require a pull request before merging - Require review from Code Owners** | **Require approval from code owners** [branch protection setting](../protected_branches.md#require-code-owner-approval-on-a-protected-branch) **(PREMIUM)** | [GitLab 15.6](https://gitlab.com/gitlab-org/gitlab/-/issues/376683) | -| **Require a pull request before merging - Allow specified actors to bypass required pull requests** | List of users in the **Allowed to push and merge** list of [branch protection settings](../protected_branches.md#configure-a-protected-branch) **(PREMIUM)**. Without a **Premium** subscription, the list of users that are allowed to push and merge is limited to roles. | [GitLab 15.8](https://gitlab.com/gitlab-org/gitlab/-/issues/384939) | +| **Require a pull request before merging - Allow specified actors to bypass required pull requests** | List of users in the **Allowed to push and merge** list of [branch protection settings](../protected_branches.md#add-protection-to-existing-branches) **(PREMIUM)**. Without a **Premium** subscription, the list of users that are allowed to push and merge is limited to roles. | [GitLab 15.8](https://gitlab.com/gitlab-org/gitlab/-/issues/384939) | Mapping GitHub rule **Require status checks to pass before merging** to [external status checks](../merge_requests/status_checks.md) was considered in issue diff --git a/doc/user/project/integrations/asana.md b/doc/user/project/integrations/asana.md index b1a4d2a2f78..352f6cdc2bb 100644 --- a/doc/user/project/integrations/asana.md +++ b/doc/user/project/integrations/asana.md @@ -39,6 +39,7 @@ Complete these steps in GitLab: 1. Paste the token you generated in Asana. 1. Optional. To restrict this setting to specific branches, list them in the **Restrict to branch** field, separated with commas. -1. Select **Save changes** or optionally select **Test settings**. +1. Optional. Select **Test settings**. +1. Select **Save changes**. <!-- ## Troubleshooting --> diff --git a/doc/user/project/integrations/bamboo.md b/doc/user/project/integrations/bamboo.md index 23990036f4e..05bdd039f12 100644 --- a/doc/user/project/integrations/bamboo.md +++ b/doc/user/project/integrations/bamboo.md @@ -47,8 +47,7 @@ integration in GitLab. 1. If necessary, enter a username and password for a Bamboo user that has access to trigger the build plan. Leave these fields blank if you do not require authentication. -1. Optional. To test the configuration and trigger a build in Bamboo, - select **Test Settings**. +1. Optional. Select **Test settings**. 1. Select **Save changes**. ### Identify the Bamboo build plan build key diff --git a/doc/user/project/integrations/bugzilla.md b/doc/user/project/integrations/bugzilla.md index f2af4dc6e4d..cb6abaa4c7b 100644 --- a/doc/user/project/integrations/bugzilla.md +++ b/doc/user/project/integrations/bugzilla.md @@ -31,7 +31,8 @@ To enable the Bugzilla integration in a project: For example, for a project named "My Cool App": `https://bugzilla.example.org/enter_bug.cgi#h=dupes%7CMy+Cool+App`. -1. Select **Save changes** or optionally select **Test settings**. +1. Optional. Select **Test settings**. +1. Select **Save changes**. After you configure and enable Bugzilla, a link appears on the GitLab project pages. This link takes you to the appropriate Bugzilla project. diff --git a/doc/user/project/integrations/clickup.md b/doc/user/project/integrations/clickup.md index 255f0c3f56b..4353749dd33 100644 --- a/doc/user/project/integrations/clickup.md +++ b/doc/user/project/integrations/clickup.md @@ -21,7 +21,8 @@ To enable the ClickUp integration in a project: - **Issue URL**: The URL to the ClickUp project issue to link to this GitLab project. The URL must contain `:id`. GitLab replaces this ID with the issue number. -1. Select **Save changes** or optionally select **Test settings**. +1. Optional. Select **Test settings**. +1. Select **Save changes**. After you have configured and enabled ClickUp, you see the ClickUp link on the GitLab project pages, which takes you to your ClickUp project. diff --git a/doc/user/project/integrations/ewm.md b/doc/user/project/integrations/ewm.md index 39dd548e7ca..7f87e9fc81f 100644 --- a/doc/user/project/integrations/ewm.md +++ b/doc/user/project/integrations/ewm.md @@ -35,7 +35,8 @@ To enable the EWM integration, in a project: Append the following fragment to your project area URL: `#action=com.ibm.team.workitem.newWorkItem`. For example, `https://example.com/ccm/web/projects/JKE%20Banking#action=com.ibm.team.workitem.newWorkItem`. -1. Select **Save changes** or optionally select **Test settings**. +1. Optional. Select **Test settings**. +1. Select **Save changes**. ## Reference EWM work items in commit messages diff --git a/doc/user/project/integrations/hangouts_chat.md b/doc/user/project/integrations/hangouts_chat.md index 1cfe1a02692..4046869072d 100644 --- a/doc/user/project/integrations/hangouts_chat.md +++ b/doc/user/project/integrations/hangouts_chat.md @@ -61,7 +61,7 @@ To enable the integration in GitLab: 1. Scroll down to the end of the page where you find a **Webhook** field. 1. Enter the webhook URL you copied from Google Chat. 1. Select the events you want to be notified about in your Google Chat space. -1. Optional. Select **Test settings** to verify the connection. +1. Optional. Select **Test settings**. 1. Select **Save changes**. To test the integration, make a change based on the events you selected and diff --git a/doc/user/project/integrations/irker.md b/doc/user/project/integrations/irker.md index df11ed3e57c..c77fffaa1ba 100644 --- a/doc/user/project/integrations/irker.md +++ b/doc/user/project/integrations/irker.md @@ -50,8 +50,9 @@ network. For more details, read It's prepended to every channel or user provided under **Recipients**, which is not a full URI. 1. Under **Recipients**, enter the users or channels to receive updates, separated by spaces (for example, `#channel1 user1`). For more details, see [Enter irker recipients](#enter-irker-recipients). -1. Optional. Under **Colorize messages**, select the checkbox. irker will highlight your messages. -1. Select **Save changes** or optionally select **Test Settings**. +1. Optional. To highlight messages, select the **Colorize messages** checkbox. +1. Optional. Select **Test settings**. +1. Select **Save changes**. ## Enter irker recipients diff --git a/doc/user/project/integrations/pivotal_tracker.md b/doc/user/project/integrations/pivotal_tracker.md index e1d48037ba8..c2392061b8f 100644 --- a/doc/user/project/integrations/pivotal_tracker.md +++ b/doc/user/project/integrations/pivotal_tracker.md @@ -44,4 +44,5 @@ Complete these steps in GitLab: 1. Paste the token you generated in Pivotal Tracker. 1. Optional. To restrict this setting to specific branches, list them in the **Restrict to branch** field, separated with commas. -1. Select **Save changes** or optionally select **Test settings**. +1. Optional. Select **Test settings**. +1. Select **Save changes**. diff --git a/doc/user/project/integrations/pumble.md b/doc/user/project/integrations/pumble.md index e05ff9489ca..5199d1a9935 100644 --- a/doc/user/project/integrations/pumble.md +++ b/doc/user/project/integrations/pumble.md @@ -33,7 +33,7 @@ notifications: 1. Select the checkboxes corresponding to the GitLab events you want to receive in Pumble. 1. Paste the **Webhook** URL for the Pumble channel. 1. Configure the remaining options. -1. Optional. To test the integration, select **Test settings**. +1. Optional. Select **Test settings**. 1. Select **Save changes**. The Pumble channel begins to receive all applicable GitLab events. diff --git a/doc/user/project/integrations/redmine.md b/doc/user/project/integrations/redmine.md index df8a6681e2b..5ef30cf413d 100644 --- a/doc/user/project/integrations/redmine.md +++ b/doc/user/project/integrations/redmine.md @@ -24,7 +24,8 @@ To enable the Redmine integration in a project: **This URL is not used and removal is planned in a future release.** For more information, see [issue 327503](https://gitlab.com/gitlab-org/gitlab/-/issues/327503). -1. Select **Save changes** or optionally select **Test settings**. +1. Optional. Select **Test settings**. +1. Select **Save changes**. After you have configured and enabled Redmine, you see the Redmine link on the GitLab project pages, which takes you to your Redmine project. diff --git a/doc/user/project/integrations/slack.md b/doc/user/project/integrations/slack.md index 5b769b84663..2ce1e15ff63 100644 --- a/doc/user/project/integrations/slack.md +++ b/doc/user/project/integrations/slack.md @@ -56,8 +56,8 @@ to control GitLab from Slack. Slash commands are configured separately. 1. Leave the **Labels to be notified** field blank to get all notifications, or add labels that the issue or merge request must have to trigger a notification. -1. Select **Test settings** to verify your information, and then select - **Save changes**. +1. Optional. Select **Test settings**. +1. Select **Save changes**. Your Slack team now starts receiving GitLab event notifications as configured. diff --git a/doc/user/project/integrations/unify_circuit.md b/doc/user/project/integrations/unify_circuit.md index d20b19a3aaa..4a40a6250f1 100644 --- a/doc/user/project/integrations/unify_circuit.md +++ b/doc/user/project/integrations/unify_circuit.md @@ -23,6 +23,7 @@ In GitLab: 1. Paste the **Webhook URL** that you copied from the Unify Circuit configuration step. 1. Select the **Notify only broken pipelines** checkbox to notify only on failures. 1. In the **Branches for which notifications are to be sent** dropdown list, select which types of branches to send notifications for. -1. Select `Save changes` or optionally select **Test settings**. +1. Optional. Select **Test settings**. +1. Select **Save changes**. Your Unify Circuit conversation now starts receiving GitLab event notifications. diff --git a/doc/user/project/integrations/webex_teams.md b/doc/user/project/integrations/webex_teams.md index c755c7a5c17..2388014db06 100644 --- a/doc/user/project/integrations/webex_teams.md +++ b/doc/user/project/integrations/webex_teams.md @@ -33,6 +33,7 @@ notifications: 1. Ensure that the **Active** toggle is enabled. 1. Select the checkboxes corresponding to the GitLab events you want to receive in Webex Teams. 1. Paste the **Webhook** URL for the Webex Teams space. -1. Configure the remaining options and then select **Test settings and save changes**. +1. Optional. Select **Test settings**. +1. Select **Save changes**. The Webex Teams space begins to receive all applicable GitLab events. diff --git a/doc/user/project/integrations/youtrack.md b/doc/user/project/integrations/youtrack.md index ee5ca8eca78..b1c7b533c0f 100644 --- a/doc/user/project/integrations/youtrack.md +++ b/doc/user/project/integrations/youtrack.md @@ -22,7 +22,8 @@ To enable the YouTrack integration in a project: - **Project URL**: The URL to the project in YouTrack. - **Issue URL**: The URL to view an issue in the YouTrack project. The URL must contain `:id`. GitLab replaces `:id` with the issue number. -1. Select **Save changes** or optionally select **Test settings**. +1. Optional. Select **Test settings**. +1. Select **Save changes**. After you configure and enable YouTrack, a link appears on the GitLab project pages. This link takes you to the appropriate YouTrack project. diff --git a/doc/user/project/integrations/zentao.md b/doc/user/project/integrations/zentao.md index 19f6a3e315c..b14b9eac9da 100644 --- a/doc/user/project/integrations/zentao.md +++ b/doc/user/project/integrations/zentao.md @@ -52,7 +52,7 @@ Complete these steps in GitLab: ![ZenTao settings page](img/zentao_product_id.png) -1. To verify the ZenTao connection is working, select **Test settings**. +1. Optional. Select **Test settings**. 1. Select **Save changes**. <!--- end_remove --> diff --git a/doc/user/project/protected_branches.md b/doc/user/project/protected_branches.md index 3255c38fd25..2f303bf5316 100644 --- a/doc/user/project/protected_branches.md +++ b/doc/user/project/protected_branches.md @@ -42,7 +42,7 @@ When a branch is protected, the default behavior enforces these restrictions on When a branch matches multiple rules, the **most permissive rule** determines the level of protection for the branch. For example, consider these rules, which include -[wildcards](#configure-multiple-protected-branches-by-using-a-wildcard): +[wildcards](#protect-multiple-branches-with-wildcard-rules): | Branch name pattern | Allowed to merge | Allowed to push and merge | |---------------------|------------------------|-----------------| @@ -77,11 +77,11 @@ that matches `v1.x` must set `Allowed to push and merge` to `No one`, like this: Administrators can set a default branch protection level in the [Admin Area](../project/repository/branches/default.md#instance-level-default-branch-protection). -## Configure a protected branch +## Add protection to existing branches Configure protected branches for all projects in a group, or just for a project. -### For a project +### For one project Prerequisites: @@ -133,11 +133,12 @@ To protect a branch for all the projects in a group: The protected branch is added to the list of protected branches. -## Configure multiple protected branches by using a wildcard +## Protect multiple branches with wildcard rules -If both a specific rule and a wildcard rule apply to the same branch, the most -permissive rule controls how the branch behaves. For merge controls to work properly, -set **Allowed to push and merge** to a broader set of users than **Allowed to merge**. +When using wildcards, multiple rules can apply to a single branch. +If more than one rule applies to a branch, the _most permissive_ rule controls +how the branch behaves. For merge controls to work properly, set +**Allowed to push and merge** to a broader set of users than **Allowed to merge**. Prerequisite: @@ -165,13 +166,13 @@ To protect multiple branches at the same time: The protected branch displays in the list of protected branches. -## Create a protected branch +## Create a new branch with protections -Users with at least the Developer role can create a protected branch. +Users with at least the Developer role can create new protected branches. Prerequisites: -- **Allowed to push and merge** is set to **No one** +- **Allowed to push and merge** is set to **No one**. - **Allowed to merge** is set to **Developers**. You can create a protected branch by using the UI or API only. diff --git a/doc/user/project/repository/push_rules.md b/doc/user/project/repository/push_rules.md index 28afba375fc..4d05ea701b7 100644 --- a/doc/user/project/repository/push_rules.md +++ b/doc/user/project/repository/push_rules.md @@ -19,6 +19,7 @@ can and can't be pushed to your repository. While GitLab offers GitLab uses [RE2 syntax](https://github.com/google/re2/wiki/Syntax) for regular expressions in push rules. You can test them at the [regex101 regex tester](https://regex101.com/). +Each regular expression is limited to 255 characters. For custom push rules use [server hooks](../../../administration/server_hooks.md). diff --git a/doc/user/project/wiki/index.md b/doc/user/project/wiki/index.md index eb13814f2ad..a6784e598da 100644 --- a/doc/user/project/wiki/index.md +++ b/doc/user/project/wiki/index.md @@ -288,7 +288,7 @@ To add a link to an external wiki from a project's left sidebar: 1. On the left sidebar, select **Settings > Integrations**. 1. Select **External wiki**. 1. Add the URL to your external wiki. -1. Optional. To verify the connection, select **Test settings**. +1. Optional. Select **Test settings**. 1. Select **Save changes**. You can now see the **External wiki** option from your project's |