## Understanding this change ### Does this change impact you? The steps for users on a SaaS platform (GitLab.com, GitLab Dedicated) and for self-managed to check whether they will be impacted are: 1. Browse to the project you want to check 2. Check the GitLab CI/CD configuration files (e.g. `.gitlab-ci.yml`) 3. If the `Code-Quality.gitlab-ci.yaml` template is included, the project is impacted The [Advanced Search Deprecations](https://gitlab.com/gitlab-com/cs-tools/gitlab-cs-tools/deprecation-migration-tools/advanced-search-deprecations/) tool can be used to check for the impact of this change. If the [output](https://gitlab.com/gitlab-com/cs-tools/gitlab-cs-tools/deprecation-migration-tools/advanced-search-deprecations/-/tree/main?ref_type=heads#output-files) mentions `CodeClimate-based Code Quality scanning will be removed` in a row, the project in that particular finding is impacted. ### What does impact from this change look like? If you are impacted by this change, you will notice that the `Code-Quality.gitlab-ci.yml` CI/CD template no longer executes scans. You might notice errors if other [need] (https://docs.gitlab.com/ci/yaml/#needs) or [depend](https://docs.gitlab.com/ci/yaml/#dependencies) on the CodeClimate-based Code Quality scanning that this template used to execute. We won't delete previously published container images or remove the ability to run them by using custom CI/CD pipeline job definitions. ~~:warning: On GitLab.com, this will occur during [window 1](https://docs.gitlab.com/update/breaking_windows/#window-1) (April 21 - 23, 2025 from 09:00 UTC to 22:00 UTC) – _before_ the release of GitLab 18.0.~~ ~~📅 This change has been postponed to %19.0~~ 📅 **The removal milestone is Pending.** This change was previously scheduled for GitLab 18.0, then GitLab 19.0. Neither date was met and the removal has not yet happened. A new removal milestone is pending management approval. We currently expect GitLab 19.5, and this issue will be updated when the milestone is confirmed. ### How to prepare for this change? The steps for users on a SaaS platform (GitLab.com, GitLab Dedicated) and for self-managed to prepare for this change are: 1. Remove the `Code-Quality.gitlab-ci.yml` CI/CD template from your GitLab CI/CD configuration To replace the functionality provided by including the `Code-Quality.gitlab-ci.yml` CI/CD template, you can optionally: 1. Choose another tool to integrate with Code Quality 2. [Integrate](https://docs.gitlab.com/ci/testing/code_quality/#integrate-common-tools-with-code-quality) the tool into your CI/CD pipeline 3. [Import](https://docs.gitlab.com/ci/testing/code_quality/#import-code-quality-results-from-a-cicd-job) the results generated by the tool you chose as a [`codequality` report artifact](https://docs.gitlab.com/ci/yaml/artifacts_reports/#artifactsreportscodequality) We maintain a list of [common tools with Code Quality](https://docs.gitlab.com/ci/testing/code_quality/#integrate-common-tools-with-code-quality) that you can choose from. --- GitLab customers with an active subscriptions can reach out to [GitLab Support](https://support.gitlab.com/) when encountering problems with the guidance above. --- ~~For guidance on the overall deprecations, removals and breaking changes workflow, please visit [Breaking changes, deprecations, and removing features](https://about.gitlab.com/handbook/product/gitlab-the-product/#deprecations-removals-and-breaking-changes)~~ You can learn more about upcoming changes in the [Deprecations and removals by version](https://docs.gitlab.com/update/deprecations/) and [Breaking change deployments on GitLab.com](https://docs.gitlab.com/update/breaking_windows/) docs. <!--Use this template as a starting point for deprecations.--> ### Deprecation Summary <!--This should contain a brief description of the feature or functionality that is deprecated. The description should clearly state the potential impact of the deprecation to end users. It is recommended that you link to the documentation. The description of the deprecation should state what actions the user should take to rectify the behavior. If the deprecation is scheduled for an upcoming release, the content should remain in the deprecations documentation page until it has been completed. For example, if a deprecation is announced in 14.9 and scheduled to be completed in 15.0, the same content would be included in the documentation for 14.9, 14.10, and 15.0. **If this issue proposes a breaking change outside a major release XX.0, you need to get approval from your manager and request collaboration from Product Operations on communication. Be sure to follow the guidance [here](https://about.gitlab.com/handbook/product/gitlab-the-product/#deprecations-removals-and-breaking-changes.)**--> _Note: This is a **copy** of the deprecation notice that is published [in documentation](https://docs.gitlab.com/ee/update/deprecations.html#codeclimate-based-code-quality-scanning-will-be-removed)._ We will remove CodeClimate-based Code Quality scanning in a future release. 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). 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). We expect to implement this change by: 1. Changing the [`Code-Quality.gitlab-ci.yml` CI/CD template](https://gitlab.com/gitlab-org/gitlab/-/blob/master/lib/gitlab/ci/templates/Jobs/Code-Quality.gitlab-ci.yml) to no longer execute scans. Today, this template runs CodeClimate-based scans. (We plan to change the template rather than delete it to reduce the impact on any pipelines that still `include` the template after removal.) 1. No longer running CodeClimate-based scanning as part of Auto DevOps. Effective immediately, CodeClimate-based scanning will receive only [limited updates](https://docs.gitlab.com/ee/update/terminology.html#deprecation). After End of Support, we won't provide further updates. However, we won't delete previously published container images or remove the ability to run them by using custom CI/CD pipeline job definitions. For more details, see [Scan code for quality violations](https://docs.gitlab.com/ee/ci/testing/code_quality.html#scan-code-for-quality-violations). ### Breaking Change Yes. #### Action required For more details, see [Scan code for quality violations](https://docs.gitlab.com/ee/ci/testing/code_quality.html#scan-code-for-quality-violations). <!--Does this MR contain a breaking change? If yes: - Add the ~"breaking change" label to this issue. - Add instructions for how users can update their workflow.--> ### Affected Topology All deployment types ### Affected Tier All tiers ### Deprecation Milestone %"17.2" <!--In which milestone will this deprecation be announced ?--> ### Planned Removal Milestone Pending management approval. Currently expected in %19.5. <!--In which milestone will the feature or functionality be removed and announced?--> ### Links <!--Add links to any relevant documentation or code that will provide additional details or clarity regarding the planned change. This issue is the main SSOT for the deprecations and removals process. Be sure to link all issues and MRs related to this deprecation/removal to this issue. This can include removal issues that were created ahead of time, and the MRs doing the actual deprecation/removal work.--> ### Checklists <details> <summary>Click to expand</summary> **Labels** - [x] This issue is labeled ~deprecation, and with the relevant `~devops::`, `~group::`, and `~Category:` labels. - [x] This issue is labeled ~"breaking change" if the removal of the deprecated item will be a [breaking change](https://about.gitlab.com/handbook/product/gitlab-the-product/#examples-of-breaking-changes). **Timeline** ~~Window 1 This window takes place on April 21 - 23, 2025 from 09:00 UTC to 22:00 UTC.~~ Please add links to the relevant merge requests. - As soon as possible, but no later than the third milestone preceding the major release (for example, given the following release schedule: `14.8, 14.9, 14.10, 15.0` – `14.8` is the third milestone preceding the major release): - [ ] A [deprecation announcement entry](https://about.gitlab.com/handbook/marketing/blog/release-posts/#creating-the-announcement) has been created so the deprecation will appear in release posts and on the [general deprecation page](https://docs.gitlab.com/ee/update/deprecations). - See MR: https://gitlab.com/gitlab-org/gitlab/-/merge_requests/158840+s - [ ] Documentation has been updated to mark the feature as [deprecated](https://docs.gitlab.com/ee/development/documentation/versions.html#deprecations-and-removals). - [x] On or before the major milestone: A [removal entry](https://about.gitlab.com/handbook/marketing/blog/release-posts/#creating-the-announcement-1) has been created so the removal will appear on the [removals by milestones](https://docs.gitlab.com/ee/update/removals) page and be announced in the release post. - _Note:_ this page no longer exists - On the major milestone: - [ ] The deprecated item has been removed. - [ ] If the removal of the deprecated item is a [breaking change](https://about.gitlab.com/handbook/product/gitlab-the-product/#examples-of-breaking-changes), the merge request is labeled ~"breaking change". **Mentions** - [ ] Your stage's stable counterparts have been `@mentioned` on this issue. For example, Customer Support, Customer Success (Technical Account Manager), Product Marketing Manager. - To see who the stable counterparts are for a product team visit [product categories](https://about.gitlab.com/handbook/product/categories/) - If there is no stable counterpart listed for Sales/CS please mention `@timtams` - If there is no stable counterpart listed for Support please mention `@gitlab-com/support/managers` - If there is no stable counterpart listed for Marketing please mention `@cfoster3` - [ ] Your GPM has been `@mentioned` so that they are aware of planned deprecations. The goal is to have reviews happen at least two releases before the final removal of the feature or introduction of a breaking change. </details>