You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: data/deprecations/17-3-codeclimate.yml
+3-3Lines changed: 3 additions & 3 deletions
Original file line number
Diff line number
Diff line change
@@ -7,8 +7,8 @@
7
7
issue_url: https://gitlab.com/gitlab-org/gitlab/-/issues/471677 # (required) Link to the deprecation issue in GitLab
8
8
body: | # (required) Do not modify this line, instead modify the lines below.
9
9
In GitLab 18.0, we will remove CodeClimate-based Code Quality scanning.
10
-
However, you'll still be able to import results from quality tools by [providing a report as an artifact](https://docs.gitlab.com/ee/ci/testing/code_quality.html#implement-a-custom-tool), just as you can today.
11
-
In addition, you can also see this [epic](https://gitlab.com/groups/gitlab-org/-/epics/8790) for new directions considered for Code Quality.
10
+
In its place, you should use quality tools directly in your CI/CD pipeline and [provide the tool's report as an artifact](https://docs.gitlab.com/ee/ci/testing/code_quality.html#import-code-quality-results-from-a-cicd-job).
11
+
Many tools already support the required report format, and you can integrate them by following the [documented steps](https://docs.gitlab.com/ee/ci/testing/code_quality.html#integrate-common-tools-with-code-quality).
12
12
13
13
We expect to implement this change by:
14
14
@@ -19,4 +19,4 @@
19
19
After End of Support in GitLab 18.0, we won't provide further updates.
20
20
However, we won't delete previously published container images or remove the ability to run them by using custom CI/CD pipeline job definitions.
21
21
22
-
For more details and required actions, see the [deprecation issue for this change](https://gitlab.com/gitlab-org/gitlab/-/issues/471677#action-required).
22
+
For more details, see [Scan code for quality violations](https://docs.gitlab.com/ee/ci/testing/code_quality.html#scan-code-for-quality-violations).
Copy file name to clipboardExpand all lines: doc/ci/testing/code_quality.md
+3-14Lines changed: 3 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -43,7 +43,9 @@ You can also [integrate multiple tools](#integrate-multiple-tools).
43
43
Many development teams already use linters, style checkers, or other tools in their CI/CD pipelines to automatically detect violations of coding standards.
44
44
You can make the findings from these tools easier to see and fix by integrating them with Code Quality.
45
45
46
-
To integrate a tool with Code Quality:
46
+
To see if your tool already has a documented integration, see [Integrate common tools with Code Quality](#integrate-common-tools-with-code-quality).
47
+
48
+
To integrate a different tool with Code Quality:
47
49
48
50
1. Add the tool to your CI/CD pipeline.
49
51
1. Configure the tool to output a report as a file.
@@ -76,19 +78,6 @@ You can capture results from multiple tools in a single pipeline.
76
78
For example, you can run a code linter to scan your code along with a language linter to scan your documentation, or you can use a standalone tool along with CodeClimate-based scanning.
77
79
Code Quality combines all of the reports so you see all of them when you [view results](#view-code-quality-results).
78
80
79
-
Here is an example that returns ESLint output in the necessary format:
Copy file name to clipboardExpand all lines: doc/update/deprecations.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -209,8 +209,8 @@ This is one small step towards moving away from CI/CD templates in preference of
209
209
</div>
210
210
211
211
In GitLab 18.0, we will remove CodeClimate-based Code Quality scanning.
212
-
However, you'll still be able to import results from quality tools by [providing a report as an artifact](https://docs.gitlab.com/ee/ci/testing/code_quality.html#implement-a-custom-tool), just as you can today.
213
-
In addition, you can also see this [epic](https://gitlab.com/groups/gitlab-org/-/epics/8790) for new directions considered for Code Quality.
212
+
In its place, you should use quality tools directly in your CI/CD pipeline and [provide the tool's report as an artifact](https://docs.gitlab.com/ee/ci/testing/code_quality.html#import-code-quality-results-from-a-cicd-job).
213
+
Many tools already support the required report format, and you can integrate them by following the [documented steps](https://docs.gitlab.com/ee/ci/testing/code_quality.html#integrate-common-tools-with-code-quality).
214
214
215
215
We expect to implement this change by:
216
216
@@ -221,7 +221,7 @@ Effective immediately, CodeClimate-based scanning will receive only [limited upd
221
221
After End of Support in GitLab 18.0, we won't provide further updates.
222
222
However, we won't delete previously published container images or remove the ability to run them by using custom CI/CD pipeline job definitions.
223
223
224
-
For more details and required actions, see the [deprecation issue for this change](https://gitlab.com/gitlab-org/gitlab/-/issues/471677#action-required).
224
+
For more details, see [Scan code for quality violations](https://docs.gitlab.com/ee/ci/testing/code_quality.html#scan-code-for-quality-violations).
Copy file name to clipboardExpand all lines: doc/user/compliance/license_scanning_of_cyclonedx_files/index.md
+4-1Lines changed: 4 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -14,6 +14,7 @@ DETAILS:
14
14
> -[Generally available](https://gitlab.com/gitlab-org/gitlab/-/issues/385176) in GitLab 16.4. Feature flags `license_scanning_sbom_scanner` and `package_metadata_synchronization` removed.
15
15
> - The legacy License Compliance analyzer (`License-Scanning.gitlab-ci.yml`) was [removed](https://gitlab.com/gitlab-org/gitlab/-/issues/439162) in GitLab 17.0.
16
16
> - In GitLab 17.5 we introduced the ability to use a CycloneDX report artifact as a source of data for license information behind the feature flag `license_scanning_with_sbom_licenses`, disabled by default.
17
+
> - In GitLab 17.6 the ability to use a CycloneDX report artifact as a source of data for license information has been enabled by default. The feature flag `license_scanning_with_sbom_licenses` is still present to disable the feature if necessary.
17
18
18
19
To detect the licenses in use, License Compliance relies on running the
19
20
[Dependency Scanning CI Jobs](../../application_security/dependency_scanning/index.md),
@@ -210,14 +211,16 @@ CycloneDX reports for licenses. For more information, see the offline [quick sta
210
211
211
212
## Use CycloneDX report as a source of license information
212
213
213
-
The ability to use a CI report artifact as a source of license information data was introduced in GitLab 17.5 behind the feature flag `license_scanning_with_sbom_licenses`.
214
+
The ability to use a CI report artifact as a source of license information data was introduced in GitLab 17.5 behind the feature flag `license_scanning_with_sbom_licenses` and enabled by default in 17.6.
214
215
215
216
When the feature flag `license_scanning_with_sbom_licenses` is enabled, the License Scanning uses the [licenses](https://cyclonedx.org/use-cases/#license-compliance) field of the CycloneDX JSON SBOM when available. If the license information is unavailable, the license information imported from the external license database will be used(current behavior).
216
217
License information can be provided using a valid SPDX identifier or a license name. However, providing a license using an SPDX License Expression is not supported.
217
218
More information about the license field format can be found on the [CycloneDX](https://cyclonedx.org/use-cases/#license-compliance) specification.
218
219
219
220
Compatible CycloneDX SBOM generators that provide the licenses field can be found in the [CycloneDX Tool Center](https://cyclonedx.org/tool-center/).
220
221
222
+
Only licenses providing an SPDX identifier are currently supported. Extending this feature beyond SDPX licenses is tracked in [issue 505677](https://gitlab.com/gitlab-org/gitlab/-/issues/505677).
223
+
221
224
## Troubleshooting
222
225
223
226
### A CycloneDX file is not being scanned and appears to provide no results
0 commit comments