Skip to content

Commit 71d614b

Browse files
authored
Update with deprecation notice.md
1 parent 3cd597b commit 71d614b

File tree

1 file changed

+21
-41
lines changed

1 file changed

+21
-41
lines changed

Diff for: README.md

+21-41
Original file line numberDiff line numberDiff line change
@@ -1,51 +1,31 @@
1-
# Code Climate golangci Engine
1+
# Try Qlty today, the newest edition of Code Climate Quality.
2+
#### This repository is deprecated and archived.
23

3-
`codeclimate-golangci` is a Code Climate engine that executes [`golangci-lint`](https://github.com/golangci/golangci-lint) and reports findings to Code Climate.
4+
This is a repository for a Code Climate Quality plugin which is packaged as a Docker image.
45

5-
### Installation & Usage
6+
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.
67

7-
1. If you haven't already, [install the Code Climate CLI](https://github.com/codeclimate/codeclimate).
8-
2. Run `codeclimate engines:enable golangci`. This command both installs the engine and enables it in your `.codeclimate.yml` file.
9-
3. Configure `golangci-lint` through its [configuration file](https://golangci-lint.run/usage/configuration/).
10-
3. You're ready to analyze! Browse into your project's folder and run `codeclimate analyze`.
8+
As a result, this repository is no longer maintained and has been archived.
119

12-
### Configuration
10+
## Advantages of Qlty plugins
11+
The new Qlty plugins system provides key advantages over the older, Docker-based plugin system:
1312

14-
You can enable the engine using your `.codeclimate.yml`:
13+
- Linting runs much faster without the overhead of virtualization
14+
- New versions of linters are available immediately without needing to wait for a re-packaged release
15+
- Plugins can be run with any arbitrary extensions (like extra rules and configs) without requiring pre-packaging
16+
- Eliminates security issues associated with exposing a Docker daemon
1517

16-
```yaml
17-
engines:
18-
golangci:
19-
enabled: true
20-
```
18+
## Try out Qlty today free
2119

22-
Then, configure `golangci-lint` through its [configuration file](https://golangci-lint.run/usage/configuration/).
20+
[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.
2321

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

26-
For help with `codeclimate-golangci`, please open an issue on this repository.
28+
[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.
29+
- [Try Qlty Cloud today](https://docs.qlty.sh/cloud/quickstart)
2730

28-
### License
29-
30-
```
31-
Copyright (c) 2015 Gympass.
32-
33-
Permission is hereby granted, free of charge, to any person obtaining a copy
34-
of this software and associated documentation files (the "Software"), to deal
35-
in the Software without restriction, including without limitation the rights
36-
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
37-
copies of the Software, and to permit persons to whom the Software is
38-
furnished to do so, subject to the following conditions:
39-
40-
The above copyright notice and this permission notice shall be included in
41-
all copies or substantial portions of the Software.
42-
43-
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
44-
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
45-
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
46-
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
47-
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
48-
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
49-
THE SOFTWARE.
50-
51-
```
31+
**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)