From b83fb6f20760b771e8d61d3f308a0293d7f8c5b5 Mon Sep 17 00:00:00 2001 From: Laura Date: Fri, 28 Mar 2025 18:57:32 -0300 Subject: [PATCH 1/2] Update with deprecation notice.md --- README.md | 39 ++++++++++++++++++++------------------- 1 file changed, 20 insertions(+), 19 deletions(-) diff --git a/README.md b/README.md index 9f806a88..8dfb528e 100644 --- a/README.md +++ b/README.md @@ -1,28 +1,29 @@ -# Code Climate Rubocop Engine +# This repository is deprecated and archived +This is a repository for a Code Climate Quality plugin which is packaged as a Docker image. -[![Code Climate](https://codeclimate.com/github/codeclimate/codeclimate-rubocop/badges/gpa.svg)](https://codeclimate.com/github/codeclimate/codeclimate-rubocop) +Code Climate Quality is being replaced with the new [Qlty](qlty.sh) code quality platform. Qlty uses a new plugin system which does not require packaging plugins as Docker images. -`codeclimate-rubocop` is a Code Climate engine that wraps the [RuboCop](https://github.com/rubocop-hq/rubocop) static analysis tool. You can run it on your command line using the Code Climate CLI, or on our hosted analysis platform. +As a result, this repository is no longer maintained and has been archived. -RuboCop helps you enforce many of the guidelines outlined in the community [Ruby Style Guide](https://github.com/rubocop-hq/ruby-style-guide). Most aspects of its behavior can be tweaked via various [configuration options](https://github.com/rubocop-hq/rubocop/blob/master/config/default.yml), which are set in a **.rubocop.yml** file. +## Advantages of Qlty plugins +The new Qlty plugins system provides key advantages over the older, Docker-based plugin system: -You can find some basic setup instructions and links to the RuboCop OSS project below. For additional Code Climate-specific config details, check out our [RuboCop engine documentation][cc-docs-rubocop]. +- Linting runs much faster without the overhead of virtualization +- New versions of linters are available immediately without needing to wait for a re-packaged release +- Plugins can be run with any arbitrary extensions (like extra rules and configs) without requiring pre-packaging +- Eliminates security issues associated with exposing a Docker daemon -### Installation +## Try out Qlty today free -1. If you haven't already, [install the Code Climate CLI](https://github.com/codeclimate/codeclimate). -2. Enable the engine by adding the following under `plugins` in your `.codeclimate.yaml`: - ```yaml - plugins: - rubocop: - enabled: true - ``` -3. You're ready to analyze! Browse into your project's folder and run `codeclimate analyze`. +[Qlty CLI](https://docs.qlty.sh/cli/quickstart) is the fastest linter and auto-formatter for polyglot teams. It is completely free and available for Mac, Windows, and Linux. -### Need help? + - Install Qlty CLI: +` +curl https://qlty.sh | sh # Mac or Linux +` +or ` ` -For help with RuboCop, [check out their documentation](https://github.com/rubocop-hq/rubocop). +[Qlty Cloud](https://docs.qlty.sh/cloud/quickstart) is a full code health platform for integrating code quality into development team workflows. It is free for unlimited private contributors. + - [Try Qlty Cloud today](https://docs.qlty.sh/cloud/quickstart) -If you're running into a Code Climate issue, first check out [our RuboCop engine docs][cc-docs-rubocop] and look over this project's [GitHub Issues](https://github.com/codeclimate/codeclimate-rubocop/issues), as your question may have already been covered. If not, [go ahead and open a support ticket with us](https://codeclimate.com/help). - -[cc-docs-rubocop]: https://docs.codeclimate.com/docs/rubocop +**Note**: For existing customers of Quality, please see our [Migration Guide](https://docs.qlty.sh/migration/guide) for more information and resources. From 6fcdedd1b903d118b7ae008cf40cef43a8ad863f Mon Sep 17 00:00:00 2001 From: Laura Date: Tue, 15 Apr 2025 17:37:53 -0300 Subject: [PATCH 2/2] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 8dfb528e..c17698dc 100644 --- a/README.md +++ b/README.md @@ -21,7 +21,7 @@ The new Qlty plugins system provides key advantages over the older, Docker-based ` curl https://qlty.sh | sh # Mac or Linux ` -or ` ` +or ` powershell -c "iwr https://qlty.sh | iex" # Windows` [Qlty Cloud](https://docs.qlty.sh/cloud/quickstart) is a full code health platform for integrating code quality into development team workflows. It is free for unlimited private contributors. - [Try Qlty Cloud today](https://docs.qlty.sh/cloud/quickstart)