Skip to content

Commit 5fb4231

Browse files
authored
Update with deprecation notice.md (#378)
1 parent 722a50a commit 5fb4231

File tree

1 file changed

+20
-19
lines changed

1 file changed

+20
-19
lines changed

README.md

+20-19
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,29 @@
1-
# Code Climate Rubocop Engine
1+
# This repository is deprecated and archived
2+
This is a repository for a Code Climate Quality plugin which is packaged as a Docker image.
23

3-
[![Code Climate](https://codeclimate.com/github/codeclimate/codeclimate-rubocop/badges/gpa.svg)](https://codeclimate.com/github/codeclimate/codeclimate-rubocop)
4+
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.
45

5-
`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.
6+
As a result, this repository is no longer maintained and has been archived.
67

7-
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.
8+
## Advantages of Qlty plugins
9+
The new Qlty plugins system provides key advantages over the older, Docker-based plugin system:
810

9-
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].
11+
- Linting runs much faster without the overhead of virtualization
12+
- New versions of linters are available immediately without needing to wait for a re-packaged release
13+
- Plugins can be run with any arbitrary extensions (like extra rules and configs) without requiring pre-packaging
14+
- Eliminates security issues associated with exposing a Docker daemon
1015

11-
### Installation
16+
## Try out Qlty today free
1217

13-
1. If you haven't already, [install the Code Climate CLI](https://github.com/codeclimate/codeclimate).
14-
2. Enable the engine by adding the following under `plugins` in your `.codeclimate.yaml`:
15-
```yaml
16-
plugins:
17-
rubocop:
18-
enabled: true
19-
```
20-
3. You're ready to analyze! Browse into your project's folder and run `codeclimate analyze`.
18+
[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.
2119

22-
### Need help?
20+
- Install Qlty CLI:
21+
`
22+
curl https://qlty.sh | sh # Mac or Linux
23+
`
24+
or ` <windows install line> `
2325

24-
For help with RuboCop, [check out their documentation](https://github.com/rubocop-hq/rubocop).
26+
[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.
27+
- [Try Qlty Cloud today](https://docs.qlty.sh/cloud/quickstart)
2528

26-
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).
27-
28-
[cc-docs-rubocop]: https://docs.codeclimate.com/docs/rubocop
29+
**Note**: For existing customers of Quality, please see our [Migration Guide](https://docs.qlty.sh/migration/guide) for more information and resources.

0 commit comments

Comments
 (0)