Remove License Compliance docs
Why are we doing this work
- the license compliance feature was removed in %16.2 (Prepare removal of License-Check feature (#397067 - closed))
- the docs need to be removed as well
- any reference to the docs in either other docs or as help paths need to be updated
Sample instances of License Compliance Docs/Help path
33 results - 24 files
app/views/projects/merge_requests/_widget.html.haml:
15 window.gl.mrWidgetData.security_configuration_path = '#{project_security_configuration_path(@project)}';
16: window.gl.mrWidgetData.license_compliance_docs_path = '#{help_page_path('user/compliance/license_compliance/index.md')}';
17 window.gl.mrWidgetData.eligible_approvers_docs_path = '#{help_page_path('user/project/merge_requests/approvals/rules.md', anchor: 'eligible-approvers')}';
doc/ci/testing/index.md:
20 | [Unit test reports](unit_test_reports.md) | Configure your CI jobs to use Unit test reports, and let GitLab display a report on the merge request so that it's easier and faster to identify the failure without having to check the entire job log. |
21: | [License Compliance](../../user/compliance/license_compliance/index.md) | Manage the licenses of your dependencies. |
22 | [Metrics Reports](metrics_reports.md) | Display the Metrics Report on the merge request so that it's fast and easier to identify changes to important metrics. |
doc/ci/yaml/artifacts_reports.md:
251
252: The License Compliance report collects [Licenses](../../user/compliance/license_compliance/index.md). The License
253 Compliance report uploads to GitLab as an artifact.
256
257: - The merge request [license compliance widget](../../user/compliance/license_compliance/index.md).
258 - The [license list](../../user/compliance/license_list.md).
doc/development/fips_compliance.md:
62 - [Dynamic Application Security Testing (DAST)](../user/application_security/dast/index.md) supports a reduced set of analyzers. Browser-based and proxy-based analyzers are not available in FIPS mode today, however DAST API and DAST API Fuzzing images are available.
63: - [License compliance](../user/compliance/license_compliance/index.md).
64 - [Solutions for vulnerabilities](../user/application_security/vulnerabilities/index.md#resolve-a-vulnerability)
doc/development/go_guide/index.md:
148 dependency should be argued in the merge request, as per our [Approval Guidelines](../code_review.md#approval-guidelines).
149: Both [License Scanning](../../user/compliance/license_compliance/index.md)
150 and [Dependency Scanning](../../user/application_security/dependency_scanning/index.md)
doc/development/sec/analyzer_development_guide.md:
344 - [Supported languages in DS](../../user/application_security/dependency_scanning/index.md#supported-languages-and-package-managers)
345: - [Supported languages in LM](../../user/compliance/license_compliance/index.md#supported-languages-and-package-managers)
346
doc/install/openshift_and_gitlab/index.md:
33
34: - [License Compliance via the `License-Scanning.gitlab-ci.yml` CI/CD template](../../user/compliance/license_compliance/index.md). [License scanning of CycloneDX files](../../user/compliance/license_scanning_of_cyclonedx_files/index.md) is supported on OpenShift.
35 - [Code Quality scanning](../../ci/testing/code_quality.md)
doc/raketasks/index.md:
41 | [SMTP maintenance](../administration/raketasks/smtp.md) | SMTP-related tasks. |
42: | [SPDX license list import](spdx.md) | Import a local copy of the [SPDX license list](https://spdx.org/licenses/) for matching [License Compliance policies](../user/compliance/license_compliance/index.md). |
43 | [Repository storage](../administration/raketasks/storage.md) | List and migrate existing projects and attachments from legacy storage to hashed storage. |
doc/raketasks/spdx.md:
9 GitLab provides a Rake task for uploading a fresh copy of the [SPDX license list](https://spdx.org/licenses/)
10: to a GitLab instance. This list is needed for matching the names of [License Compliance policies](../user/compliance/license_compliance/index.md).
11
doc/topics/autodevops/stages.md:
255 For more information, see
256: [License Compliance](../../user/compliance/license_compliance/index.md).
257
doc/user/permissions.md:
118 | [Issues](project/issues/index.md):<br>Delete | | | | | ✓ |
119: | [License Compliance](compliance/license_compliance/index.md):<br>View allowed and denied licenses | ✓ (1) | ✓ | ✓ | ✓ | ✓ |
120: | [License Compliance](compliance/license_compliance/index.md):<br>View License Compliance reports | ✓ (1) | ✓ | ✓ | ✓ | ✓ |
121: | [License Compliance](compliance/license_compliance/index.md):<br>View License list | | ✓ | ✓ | ✓ | ✓ |
122: | [License Compliance](compliance/license_compliance/index.md):<br>Manage license policy | | | | ✓ | ✓ |
123 | [Merge requests](project/merge_requests/index.md):<br>Assign reviewer | | ✓ | ✓ | ✓ | ✓ |
doc/user/application_security/index.md:
406 - [Overriding DAST jobs](dast/proxy-based.md#customize-dast-settings).
407: - [Overriding License Compliance jobs](../compliance/license_compliance/index.md#overriding-the-template).
408
doc/user/application_security/configuration/index.md:
79
80: - [License Compliance](../../../user/compliance/license_compliance/index.md)
81: - Can be configured with `.gitlab-ci.yml`. For more details, read [License Compliance](../../../user/compliance/license_compliance/index.md#enable-license-compliance).
82
doc/user/application_security/dependency_list/index.md:
77
78: If the [License Compliance](../../compliance/license_compliance/index.md) CI job is configured,
79: [discovered licenses](../../compliance/license_compliance/index.md#supported-languages-and-package-managers) are displayed on this page.
80
doc/user/application_security/offline_deployments/index.md:
92 - [API Fuzzing offline directions](../api_fuzzing/index.md#running-api-fuzzing-in-an-offline-environment)
93: - [License Compliance offline directions](../../compliance/license_compliance/index.md#running-license-compliance-in-an-offline-environment)
94 - [Dependency Scanning offline directions](../dependency_scanning/index.md#running-dependency-scanning-in-an-offline-environment)
doc/user/project/merge_requests/index.md:
297 1. You verify your changes with [Unit test reports](../../../ci/testing/unit_test_reports.md) in GitLab CI/CD.
298: 1. You avoid using dependencies whose license is not compatible with your project with [License Compliance reports](../../compliance/license_compliance/index.md).
299 1. You request the [approval](approvals/index.md) from your manager.
ee/app/assets/javascripts/vue_shared/license_compliance/license_management.vue:
7 import glFeatureFlagsMixin from '~/vue_shared/mixins/gl_feature_flags_mixin';
8: import LicenseApprovals from 'ee/approvals/components/license_compliance/index.vue';
9 import AddLicenseForm from './components/add_license_form.vue';
ee/app/controllers/projects/licenses_controller.rb:
72 write_license_policies_endpoint: write_license_policies_endpoint,
73: documentation_path: help_page_path('user/compliance/license_compliance/index'),
74 empty_state_svg_path: helpers.image_path('illustrations/Dependency-list-empty-state.svg'),
79 settings_path: expose_path(api_v4_projects_approval_settings_path(id: @project.id)),
80: approvals_documentation_path: help_page_path('user/compliance/license_compliance/index', anchor: 'enabling-license-approvals-within-a-project'),
81 locked_approvals_rule_name: ApprovalRuleLike::DEFAULT_NAME_FOR_LICENSE_REPORT
ee/spec/controllers/projects/licenses_controller_spec.rb:
53 expect(licenses_app_data[:write_license_policies_endpoint]).to eql('')
54: expect(licenses_app_data[:documentation_path]).to eql(help_page_path('user/compliance/license_compliance/index'))
55 expect(licenses_app_data[:empty_state_svg_path]).to eql(controller.helpers.image_path('illustrations/Dependency-list-empty-state.svg'))
60 expect(licenses_app_data[:settings_path]).to eql(controller.helpers.api_v4_projects_approval_settings_path(id: project.id))
61: expect(licenses_app_data[:approvals_documentation_path]).to eql(help_page_path('user/compliance/license_compliance/index', anchor: 'enabling-license-approvals-within-a-project'))
62 expect(licenses_app_data[:locked_approvals_rule_name]).to eql(ApprovalRuleLike::DEFAULT_NAME_FOR_LICENSE_REPORT)
633 expect(licenses_app_data[:write_license_policies_endpoint]).to eql(controller.helpers.api_v4_projects_managed_licenses_path(id: project.id))
634: expect(licenses_app_data[:documentation_path]).to eql(help_page_path('user/compliance/license_compliance/index'))
635 expect(licenses_app_data[:empty_state_svg_path]).to eql(controller.helpers.image_path('illustrations/Dependency-list-empty-state.svg'))
ee/spec/frontend/approvals/components/license_compliance/index_spec.js:
4 import Vuex from 'vuex';
5: import LicenseComplianceApprovals from 'ee/approvals/components/license_compliance/index.vue';
6 import approvalsLicenceComplianceModule, {
ee/spec/frontend/vue_shared/license_compliance/license_management_spec.js:
4 import Vuex from 'vuex';
5: import LicenseComplianceApprovals from 'ee/approvals/components/license_compliance/index.vue';
6 import AddLicenseForm from 'ee/vue_shared/license_compliance/components/add_license_form.vue';
lib/gitlab/ci/templates/Jobs/License-Scanning.gitlab-ci.yml:
5
6: # Read more about this feature here: https://docs.gitlab.com/ee/user/compliance/license_compliance/index.html
7 #
lib/gitlab/ci/templates/Jobs/License-Scanning.latest.gitlab-ci.yml:
5
6: # Read more about this feature here: https://docs.gitlab.com/ee/user/compliance/license_compliance/index.html
7 #
qa/qa/specs/features/ee/browser_ui/13_secure/license_compliance_spec.rb:
29 expect(license_compliance).to have_link('More Information',
30: href: %r{/help/user/compliance/license_compliance/index})
31 end
Relevant links
Non-functional requirements
-
Documentation: -
Feature flag: -
Performance: -
Testing:
Implementation plan
- continue with master...397067-prepare-removal-of-license-check-feature
- remove all references to page and replace with either
[License scanning of CycloneDX files](https://docs.gitlab.com/ee/user/compliance/license_scanning_of_cyclonedx_files/index.html)
or[License approval policies](https://docs.gitlab.com/ee/user/compliance/license_approval_policies.html)
Verification steps
Edited by Alexander Turinske