diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/administration/gitaly/configure_gitaly.md | 50 | ||||
| -rw-r--r-- | doc/administration/gitaly/reference.md | 1 | ||||
| -rw-r--r-- | doc/user/project/merge_requests/reviews/data_usage.md | 44 | ||||
| -rw-r--r-- | doc/user/project/merge_requests/reviews/img/suggested_reviewers_v15_4.png | bin | 0 -> 20617 bytes | |||
| -rw-r--r-- | doc/user/project/merge_requests/reviews/index.md | 20 | ||||
| -rw-r--r-- | doc/user/tasks.md | 7 |
6 files changed, 121 insertions, 1 deletions
diff --git a/doc/administration/gitaly/configure_gitaly.md b/doc/administration/gitaly/configure_gitaly.md index ac03c3ffc02..bfd252a9f42 100644 --- a/doc/administration/gitaly/configure_gitaly.md +++ b/doc/administration/gitaly/configure_gitaly.md @@ -1340,3 +1340,53 @@ value = "ignore" key = "receive.fsck.hasDotgit" value = "ignore" ``` + +## Configure commit signing for GitLab UI commits + +> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/19185) in GitLab 15.4. + +By default, Gitaly doesn't sign commits made using GitLab UI. For example, commits made using: + +- Web editor. +- Web IDE. +- Merge requests. + +You can configure Gitaly to sign commits made using GitLab UI. The commits show as unverified and signed by an unknown user. Support for improvements is +proposed in issue [19185](https://gitlab.com/gitlab-org/gitlab/-/issues/19185). + +**For Omnibus GitLab** + +1. [Create a GPG key](../../user/project/repository/gpg_signed_commits/index.md#create-a-gpg-key) + and export it. For optimal performance, consider using an EdDSA key. + + ```shell + gpg --export-secret-keys <ID> > signing_key.gpg + ``` + +1. On the Gitaly nodes, copy the key into `/etc/gitlab/gitaly/`. +1. Edit `/etc/gitlab/gitlab.rb` and configure `gitaly['gpg_signing_key_path']`: + + ```ruby + gitaly['gpg_signing_key_path'] = "/etc/gitlab/gitaly/signing_key.gpg" + ``` + +1. Save the file and [reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure). + +**For installations from source** + +1. [Create a GPG key](../../user/project/repository/gpg_signed_commits/index.md#create-a-gpg-key) + and export it. For optimal performance, consider using an EdDSA key. + + ```shell + gpg --export-secret-keys <ID> > signing_key.gpg + ``` + +1. On the Gitaly nodes, copy the key into `/etc/gitlab`. +1. Edit `/home/git/gitaly/config.toml` and configure `signing_key`: + + ```toml + [git] + signing_key = "/etc/gitlab/gitaly/signing_key.gpg" + ``` + +1. Save the file and [restart GitLab](../restart_gitlab.md#installations-from-source). diff --git a/doc/administration/gitaly/reference.md b/doc/administration/gitaly/reference.md index 91780ec5661..2542848c7a8 100644 --- a/doc/administration/gitaly/reference.md +++ b/doc/administration/gitaly/reference.md @@ -129,6 +129,7 @@ The following values can be set in the `[git]` section of the configuration file | ---- | ---- | -------- | ----------- | | `bin_path` | string | no | Path to Git binary. If not set, is resolved using `PATH`. | | `catfile_cache_size` | integer | no | Maximum number of cached [cat-file processes](#cat-file-cache). Default is `100`. | +| `signing_key` | string | no | Path to [GPG signing key](configure_gitaly.md#configure-commit-signing-for-gitlab-ui-commits). If not set, Gitaly doesn't sign commits made using the UI. [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/19185) in GitLab 15.4. | #### `cat-file` cache diff --git a/doc/user/project/merge_requests/reviews/data_usage.md b/doc/user/project/merge_requests/reviews/data_usage.md new file mode 100644 index 00000000000..0988e3f0042 --- /dev/null +++ b/doc/user/project/merge_requests/reviews/data_usage.md @@ -0,0 +1,44 @@ +--- +stage: ModelOps +group: Applied ML +info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments +type: index, reference +--- + +# Suggested Reviewers Data Usage + +## How it works + +Suggested Reviewers is the first user-facing GitLab machine learning (ML) powered feature. It leverages a project's contribution graph to generate suggestions. This data already exists within GitLab including merge request metadata, source code files, and GitLab user account metadata. + +### Enabling the feature + +When a Project Maintainer or Owner enables Suggested Reviewers in project settings GitLab kicks off a data extraction job for the project which leverages the Merge Request API to understand pattern of review including recency, domain experience, and frequency to suggest an appropriate reviewer. + +This data extraction job can take a few hours to complete (possibly up to a day), which is largely dependent on the size of the project. The process is automated and no action is needed during this process. Once data extraction is complete, you will start getting suggestions in merge requests. + +### Generating suggestions + +Once Suggested Reviewers is enabled and the data extraction is complete, new merge requests or new commits to existing merge requests will automatically trigger a Suggested Reviewers ML model inference and generate up to 5 suggested reviewers. These suggestions are contextual to the changes in the merge request. Additional commits to merge requests may change the reviewer suggestions which will automatically update in the reviewer dropdown. + +## Progressive enhancement + +This feature is designed as a progressive enhancement to the existing GitLab Reviewers functionality. The GitLab Reviewer UI will only offer suggestions if the ML engine is able to provide a recommendation. In the event of an issue or model inference failure, the feature will gracefully degrade. At no point with the usage of Suggested Reviewers prevent a user from being able to manually set a reviewer. + +## Model Accuracy + +Organizations use many different processes for code review. Some focus on senior engineers reviewing junior engineer's code, others have hierarchical organizational structure based reviews. Suggested Reviewers is focused on contextual reviewers based on historical merge request activity by users. While we will continue evolving the underlying ML model to better serve various code review use cases and processes Suggested Reviewers does not replace the usage of other code review features like Code Owners and [Approval Rules](../approvals/rules.md). Reviewer selection is highly subjective therefore, we do not expect Suggested Reviewers to provide perfect suggestions everytime. + +Through analysis of beta customer usage, we find that the Suggested Reviewers ML model provides suggestions that are adopted in 60% of cases. We will be introducing a feedback mechanism into the Suggested Reviewers feature in the future to allow users to flag bad reviewer suggestions to help improve the model. Additionally we will be offering an opt-in feature in the future which will allow the model to use your project's data for training the underlying model. + +## Off by default + +Suggested Reviewers is off by default and requires a Project Owner or Admin to enable the feature. + +## Data privacy + +Suggested Reviewers operates completely within the GitLab.com infrastructure providing the same level of [privacy](https://about.gitlab.com/privacy/) and [security](https://about.gitlab.com/security/) of any other feature of GitLab.com. + +No new additional data is collected to enable this feature, simply GitLab is inferencing your merge request against a trained machine learning model. The content of your source code is not used as training data. Your data also never leaves GitLab.com, all training and inference is done within GitLab.com infrastructure. + +[Read more about the security of GitLab.com](https://about.gitlab.com/security/faq/) diff --git a/doc/user/project/merge_requests/reviews/img/suggested_reviewers_v15_4.png b/doc/user/project/merge_requests/reviews/img/suggested_reviewers_v15_4.png Binary files differnew file mode 100644 index 00000000000..aae75b0736c --- /dev/null +++ b/doc/user/project/merge_requests/reviews/img/suggested_reviewers_v15_4.png diff --git a/doc/user/project/merge_requests/reviews/index.md b/doc/user/project/merge_requests/reviews/index.md index 78f82b019b8..227f38ad472 100644 --- a/doc/user/project/merge_requests/reviews/index.md +++ b/doc/user/project/merge_requests/reviews/index.md @@ -21,6 +21,26 @@ You can review merge requests from the GitLab interface. If you install the [GitLab Workflow VS Code extension](../../repository/vscode.md), you can also review merge requests in Visual Studio Code. +## Suggested reviewers **(ULTIMATE SAAS)** + +> [Introduced](https://gitlab.com/groups/gitlab-org/modelops/applied-ml/review-recommender/-/epics/3) in GitLab 15.4. + +GitLab can recommend reviewers with Suggested Reviewers. Using the changes in a merge request and a project's contribution graph, machine learning powered suggestions appear in the reviewer section of the right merge request sidebar. + + + +This feature is currently in [Open Beta](https://about.gitlab.com/handbook/product/gitlab-the-product/#open-beta) behind a [feature flag](https://gitlab.com/gitlab-org/gitlab/-/issues/368356). + +Learn more about [how suggested reviewers works and data privacy](data_usage.md). + +### Enable suggested reviewers + +Project Maintainers or Owners can enable suggested reviewers by visiting the [project settings](../../settings/index.md). + +Enabling suggested reviewers will trigger GitLab to create an ML model for your project that will be used to generate reviewers. The larger your project, the longer this can take, but usually, the model will be ready to generate suggestions within a few hours. + +No action is required once the feature is enabled. Once the model is ready, recommendations will populate the Reviewer dropdown in the right-hand sidebar of a merge request with new commits. + ## Review a merge request > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/4213) in GitLab 11.4. diff --git a/doc/user/tasks.md b/doc/user/tasks.md index 15abc77ad47..fce16b012d1 100644 --- a/doc/user/tasks.md +++ b/doc/user/tasks.md @@ -120,7 +120,12 @@ To change the assignee on a task: ## Set a start and due date -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/365399) in GitLab 15.4. +> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/365399) in GitLab 15.4 [with a flag](../administration/feature_flags.md) named `work_items_mvc_2`. Disabled by default. + +FLAG: +On self-managed GitLab, by default this feature is not available. To make it available, ask an administrator to [enable the feature flag](../administration/feature_flags.md) named `work_items_mvc_2`. +On GitLab.com, this feature is not available. +This feature is not ready for production use. You can set a [start and due date](project/issues/due_dates.md) on a task. |
