From 4c3612ed19be5f5744b0d0282d8dd0116eed76b7 Mon Sep 17 00:00:00 2001 From: Kyle Mann Date: Wed, 24 Jun 2020 13:14:05 +0000 Subject: [PATCH 1/2] Add license approval rule section --- .../compliance/license_compliance/index.md | 22 +++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/doc/user/compliance/license_compliance/index.md b/doc/user/compliance/license_compliance/index.md index 4ceb393af8ceb2..fb83eb68a0adf3 100644 --- a/doc/user/compliance/license_compliance/index.md +++ b/doc/user/compliance/license_compliance/index.md @@ -703,6 +703,28 @@ Developers of the project can view the policies configured in a project. ![View Policies](img/policies_v13_0.png) +## Enabling license approval rule + +> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/13067) in [GitLab Ultimate](https://about.gitlab.com/pricing/) 12.3. + +`License-Check` is an approval rule that may be enabled that designates an approver, individual or group, that is allowed to approve a merge request that contains a `denied` licence. + +To enable license approvals: this can be done in either the 1) [project approval rule](../project/merge_requests/merge_request_approvals.md#multiple-approval-rules-premium) section and must be created with the case-sensitive name `License-Check`, or 2) in the [project policies for License Compliance](../compliance/license_compliance/index.md#project-policies-for-license-compliance) section. This approval group must be set with the number of approvals required greater than zero. + +Once this group is enabled on your project, the approval rule is enabled for all merge requests. To apply license policies to your project, you can designate licenses to `allow` or `deny` in the [project policies for License Compliance](../compliance/license_compliance/index.md#project-policies-for-license-compliance) section. + +Any code changes cause the approvals required to reset. + +An approval is required when a license report: + +- Contains a dependency that includes a software license that is `denied`. +- Is not generated during pipeline execution. + +An approval is optional when a license report: + +- Contains no software license violations. +- Contains only new licenses that are `allowed` or unknown. + ## Troubleshooting ### `ERROR -- : asdf: No preset version installed for command` -- GitLab From a0b4141314611e33f78cd348ad9267094a9f8fc5 Mon Sep 17 00:00:00 2001 From: Kyle Mann Date: Wed, 24 Jun 2020 13:30:44 +0000 Subject: [PATCH 2/2] Removed documentation about deprecated section --- .../compliance/license_compliance/index.md | 82 ++++++------------- 1 file changed, 23 insertions(+), 59 deletions(-) diff --git a/doc/user/compliance/license_compliance/index.md b/doc/user/compliance/license_compliance/index.md index fb83eb68a0adf3..b76c84177b2f2c 100644 --- a/doc/user/compliance/license_compliance/index.md +++ b/doc/user/compliance/license_compliance/index.md @@ -604,65 +604,7 @@ and [private Yarn registries](#using-private-yarn-registries). Exact name matches are required for [project policies](#project-policies-for-license-compliance) when running in an offline environment ([see related issue](https://gitlab.com/gitlab-org/gitlab/-/issues/212388)). -## Project policies for License Compliance -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/5940) in [GitLab Ultimate](https://about.gitlab.com/pricing/) 11.4. - -From the project's settings: - -- The list of licenses and their status can be managed. -- Licenses can be manually allowed or denied. - -To allow or deny a license: - -1. Either use the **Manage licenses** button in the merge request widget, or - navigate to the project's **Settings > CI/CD** and expand the - **License Compliance** section. -1. Click the **Add a license** button. - - ![License Compliance Add License](img/license_compliance_add_license_v13_0.png) - -1. In the **License name** dropdown, either: - - Select one of the available licenses. You can search for licenses in the field - at the top of the list. - - Enter arbitrary text in the field at the top of the list. This will cause the text to be - added as a license name to the list. -1. Select the **Allow** or **Deny** radio button to allow or deny respectively - the selected license. - -To modify an existing license: - -1. In the **License Compliance** list, click the **Allow/Deny** dropdown to change it to the desired status. - - ![License Compliance Settings](img/license_compliance_settings_v13_0.png) - -Searching for Licenses: - -1. Use the **Search** box to search for a specific license. - - ![License Compliance Search](img/license_compliance_search_v13_0.png) - -## License Compliance report under pipelines - -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/5491) in [GitLab Ultimate](https://about.gitlab.com/pricing/) 11.2. - -From your project's left sidebar, navigate to **CI/CD > Pipelines** and click on the -pipeline ID that has a `license_scanning` job to see the Licenses tab with the listed -licenses (if any). - -![License Compliance Pipeline Tab](img/license_compliance_pipeline_tab_v13_0.png) - - ## License list @@ -703,7 +645,7 @@ Developers of the project can view the policies configured in a project. ![View Policies](img/policies_v13_0.png) -## Enabling license approval rule +### Enabling license approval rule > [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/13067) in [GitLab Ultimate](https://about.gitlab.com/pricing/) 12.3. @@ -725,6 +667,28 @@ An approval is optional when a license report: - Contains no software license violations. - Contains only new licenses that are `allowed` or unknown. +## License Compliance report under pipelines + +> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/5491) in [GitLab Ultimate](https://about.gitlab.com/pricing/) 11.2. + +From your project's left sidebar, navigate to **CI/CD > Pipelines** and click on the +pipeline ID that has a `license_scanning` job to see the Licenses tab with the listed +licenses (if any). + +![License Compliance Pipeline Tab](img/license_compliance_pipeline_tab_v13_0.png) + + + ## Troubleshooting ### `ERROR -- : asdf: No preset version installed for command` -- GitLab