From 2649ec4739b6b6a7a30e0ae83dfbff05de7740e0 Mon Sep 17 00:00:00 2001 From: Dave Henton Date: Fri, 21 Mar 2025 14:29:22 -0500 Subject: [PATCH 1/2] Update README.md add deprecation update --- README.md | 41 +++++++++++++++++++++++++++++------------ 1 file changed, 29 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 2c95ac5..8a0dd82 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,29 @@ -# codeclimate-checkstyle -A code climate engine for running checkstyle on your java projects. - -### Sample .codeclimate.yml configuration -```yaml -engines: - checkstyle: - enabled: true - config: 'config/checkstyle/checkstyle.xml' -``` - -By default the engine runs the [code climate checker](https://github.com/sivakumar-kailasam/codeclimate-checkstyle/blob/master/config/codeclimate_checkstyle.xml) against your code if the config property is not defined +# 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 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. + +As a result, this repository is no longer maintained and has been archived. + +## Advantages of Qlty plugins +The new Qlty plugins system provides key advantages over the older, Docker-based plugin system: + +- 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 + +## Try out Qlty today free + +[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. + + - Install Qlty CLI: +` +curl https://qlty.sh | sh # Mac or Linux +` +or ` ` + +[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) + +**Note**: For existing customers of Quality, please see our [Migration Guide](https://docs.qlty.sh/migration/guide) for more information and resources. From dd5cbbe2be527ca9d1b579720a8a4230f2cc6e48 Mon Sep 17 00:00:00 2001 From: Dave Henton Date: Tue, 25 Mar 2025 16:06:52 -0500 Subject: [PATCH 2/2] Update README.md change headline --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 8a0dd82..696e16b 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,6 @@ -# This repository is deprecated and archived +# Try Qlty today, the newest edition of Code Climate Quality. +#### 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 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.