From e8ed02804fb92bd3bb9b30fbc9844ed0ada400f5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ren=C3=A9=20F=C3=B6hring?= Date: Thu, 2 May 2024 22:06:19 +0200 Subject: [PATCH] Add compatibility note in docs --- guides/introduction/installation.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/guides/introduction/installation.md b/guides/introduction/installation.md index 8af4bd445..9ae9da54b 100644 --- a/guides/introduction/installation.md +++ b/guides/introduction/installation.md @@ -7,7 +7,7 @@ Add `:credo` as a dependency to your project's `mix.exs`: ```elixir defp deps do [ - {:credo, "~> 1.6", only: [:dev, :test], runtime: false} + {:credo, "~> 1.7", only: [:dev, :test], runtime: false} ] end ``` @@ -17,3 +17,11 @@ And run: ```bash $ mix deps.get ``` + +## Compatibility + +Credo aims to stay compatible with the list of [Elixir minor releases mentioned in the Elixir docs](https://hexdocs.pm/elixir/compatibility-and-deprecations.html). + +These are the releases that are actively tested on CI. + +Please note that Credo sometimes stays technically compatible with even earlier versions coincidentally.