Skip to content

Commit 3084e68

Browse files
authored
Update README.md
1 parent 03480fe commit 3084e68

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

README.md

+16
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,10 @@
33
[![Build Status](https://travis-ci.org/ghik/silencer.svg?branch=master)](https://travis-ci.org/ghik/silencer)
44
[![Maven Central](https://maven-badges.herokuapp.com/maven-central/com.github.ghik/silencer-plugin_2.13.2/badge.svg)](https://maven-badges.herokuapp.com/maven-central/com.github.ghik/silencer-plugin_2.13.2)
55

6+
## Compatibility
7+
8+
Silencer is available for Scala 2.11, 2.12, and 2.13.
9+
610
**NOTE**: Scala 2.13.2 and 2.12.13 introduced [configurable warnings](https://github.com/scala/scala/pull/8373).
711
This means that unless you're still cross compiling for Scala 2.11, this plugin is obsolete, and you should use
812
[`@nowarn`](https://www.scala-lang.org/api/current/scala/annotation/nowarn.html).
@@ -11,6 +15,18 @@ If you're still cross compiling for 2.11 then this plugin can be used in conjunc
1115
[scala-collection-compat](https://github.com/scala/scala-collection-compat) in order to suppress warnings in all
1216
Scala versions using `@nowarn`.
1317

18+
As a compiler plugin, Silencer must be separately built for every minor version of Scala. If you find that Silencer is not
19+
available for your version of Scala (most likely some newly released one), please contribute - the instructions on how to do it are below :)
20+
21+
### How to add support for a new version of Scala
22+
23+
1. Fork and clone the repository.
24+
1. Edit `build.sbt` and add the new Scala version to `crossScalaVersions`. Make sure to keep the order of the list,
25+
which should start with the newest version.
26+
1. Invoke `sbt githubWorkflowGenerate`
27+
1. Commit changes in `build.sbt` and Github workflow definitions
28+
1. Make a PR :)
29+
1430
## Setup
1531

1632
If you're using SBT, add this to your project definition:

0 commit comments

Comments
 (0)