set up releases

Author: gmethvin

.github/workflows/ci.yml

@@ -0,0 +1,26 @@
+name: CI
+on:
+  push:
+  pull_request:
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - uses: actions/setup-java@v4
+      with:
+        distribution: temurin
+        java-version: 8
+        cache: sbt
+    - uses: sbt/setup-sbt@v1
+    - run: sbt +test
+  format:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - uses: actions/setup-java@v4
+      with:
+        distribution: temurin
+        java-version: 8
+    - uses: sbt/setup-sbt@v1
+    - run: sbt scalafmtSbtCheck +scalafmtCheckAll

.github/workflows/release.yml

@@ -0,0 +1,24 @@
+name: Release
+on:
+  push:
+    branches: [main]
+    tags: ["*"]
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - uses: actions/setup-java@v4
+        with:
+          distribution: temurin
+          java-version: 8
+          cache: sbt
+      - uses: sbt/setup-sbt@v1
+      - run: sbt ci-release
+        env:
+          PGP_PASSPHRASE: ${{ secrets.PGP_PASSPHRASE }}
+          PGP_SECRET: ${{ secrets.PGP_SECRET }}
+          SONATYPE_PASSWORD: ${{ secrets.SONATYPE_PASSWORD }}
+          SONATYPE_USERNAME: ${{ secrets.SONATYPE_USERNAME }}

.scalafmt.conf

@@ -1,2 +1,3 @@
-version = "3.7.15"
-runner.dialect = scala213
+version = 3.9.2
+runner.dialect = scala213
+maxColumn = 120

README.md

@@ -4,38 +4,32 @@ Repository of custom scalafix rules for Iterable projects.
 
 ## Usage
 
-This library is not published anywhere yet, so you'll first need to build and publish locally with:
-```
-sbt publishLocal
+See the tags on this repo to find the the latest version or the version you want to use. You can use the rules in your project by adding a dependency to the `scalafix-rules` artifact:
+
+```scala
+ThisBuild / libraryDependencies += "com.iterable" %% "scalafix-rules" % "0.1.0" % ScalafixConfig
 ```
-Then you can reference the published library version in your project.
 
-For example, you can run version `0.1.0` of `NoFutureTraverse` dynamically in the `sbt` console:
+This will make the rules available to reference in your `.scalafix.conf` file.
+
+You can also run directly from the sbt console without including it in your build.
+For example, to run version `0.1.0` of `NoFutureTraverse` dynamically in the `sbt` console:
 
 ```
 scalafix dependency:[email protected]::scalafix-rules:0.1.0
 ```
 
-Replace the version `0.1.0` with the version you published.
-
-To run the rules by default with `scalafix` or `scalafixAll`, you'll need to add a library dependency in `build.sbt`:
+### NoFutureTraverse
 
-```scala
-ThisBuild / libraryDependencies += "com.iterable" %% "scalafix-rules" % "0.1.0" % ScalafixConfig
-```
-
-Then you can add the rules in your `.scalafix.conf` file, e.g.:
+Disallows the use of `Future.traverse` in your Scala code, to prevent a potentially unbounded number of concurrent tasks from being run at once.
 
 ```hocon
 rules = [
   # ...
-  NoFutureTraverse # validate that Future.traverse is not used
+  NoFutureTraverse
 ]
 
-# Configuration for the NoFutureTraverse rule
 NoFutureTraverse {
-  isError = true
+  isError = true # Whether to treat violations as errors (default: true)
 }
 ```
-
-

input/src/main/scala/fix/FutureSequenceTest.scala

@@ -8,6 +8,7 @@ import scala.concurrent.Await
 import scala.concurrent.ExecutionContext.Implicits.global
 import scala.concurrent.duration._
 
+/* scalafmt: { newlines.source = fold } */
 object FutureSequenceTest {
   val futures = List(Future { "hello" }, Future { "world" })
   val result = Future.sequence(futures).map(_.mkString) // assert: NoFutureTraverse

input/src/main/scala/fix/FutureTraverseTest.scala

@@ -8,8 +8,9 @@ import scala.concurrent.Await
 import scala.concurrent.ExecutionContext.Implicits.global
 import scala.concurrent.duration._
 
+/* scalafmt: { newlines.source = fold } */
 object FutureTraverseTest {
   val items = List("hello", "world")
-  val result = Future.traverse(items)(item => Future(item.length)).map(_.sum) // assert: NoFutureTraverse
-  println(Await.result(result, 1.second))
+  val sum = Future.traverse(items)(item => Future(item.length)).map(_.sum) // assert: NoFutureTraverse
+  println(Await.result(sum, 1.second))
 }

project/plugins.sbt

@@ -1,3 +1,4 @@
 addSbtPlugin("com.github.sbt" % "sbt-ci-release" % "1.9.2")
 addSbtPlugin("ch.epfl.scala" % "sbt-scalafix" % "0.13.0")
+addSbtPlugin("org.scalameta" % "sbt-scalafmt" % "2.5.4")
 dependencyOverrides += "ch.epfl.scala" % "scalafix-interfaces" % "0.13.0"

rules/src/main/scala/fix/NoFutureTraverse.scala

@@ -8,7 +8,7 @@ import scalafix.lint._
 import scalafix.v1._
 
 case class NoFutureTraverseConfig(
-  isError: Boolean = false
+    isError: Boolean = false
 )
 object NoFutureTraverseConfig {
   implicit val surface: Surface[NoFutureTraverseConfig] =
@@ -21,7 +21,8 @@ class NoFutureTraverse(config: NoFutureTraverseConfig) extends SemanticRule("NoF
 
   case class Deprecation(position: Position, name: String) extends Diagnostic {
     override def message = s"$name is deprecated"
-    override def severity = if (config.isError) LintSeverity.Error else LintSeverity.Warning
+    override def severity =
+      if (config.isError) LintSeverity.Error else LintSeverity.Warning
   }
 
   def this() = this(NoFutureTraverseConfig())
@@ -31,8 +32,10 @@ class NoFutureTraverse(config: NoFutureTraverseConfig) extends SemanticRule("NoF
       .getOrElse("NoFutureTraverse")(this.config)
       .map(c => new NoFutureTraverse(c))
 
-  val futureTraverse = SymbolMatcher.normalized("scala.concurrent.Future.traverse")
-  val futureSequence = SymbolMatcher.normalized("scala.concurrent.Future.sequence")
+  val futureTraverse =
+    SymbolMatcher.normalized("scala.concurrent.Future.traverse")
+  val futureSequence =
+    SymbolMatcher.normalized("scala.concurrent.Future.sequence")
 
   override def fix(implicit doc: SemanticDocument): Patch = {
     doc.tree.collect {