Skip to content
Permalink
Browse files

Document scala-steward:off|on markers.

  • Loading branch information...
exoego committed Jul 26, 2019
1 parent b5d0511 commit bc994eb5accac304c7029c6d2874b27eba62e7ea
Showing with 26 additions and 0 deletions.
  1. +26 −0 docs/repo-specific-configuration.md
@@ -18,3 +18,29 @@ updates.ignore = [ { groupId = "org.acme", artifactId="foo", version = "1.0" } ]
# Default: true
updatePullRequests = true
```

## Ignore lines

Though `updates.ignores` offers granular configuration to exclude dependencies from update, Scala Steward also recognizes markers in file to ignore lines.

Dependencies in lines between `// scala-steward:off` and `// scala-steward:on` are not updated.

```scala
libraryDependencies ++= Seq(
// scala-steward:off
"com.github.pathikrit" %% "better-files" % "3.8.0",
"com.olegpy" %% "better-monadic-for" % "0.3.1",
// scala-steward:on
"org.typelevel" %% "cats-effect" % "1.3.1", // This and subsequent will get updated
"org.typelevel" %% "cats-kernel-laws" % "1.6.1"
)
```

Also, the line ends with `// scala-steward:off` is not updated solely.

```scala
libraryDependencies ++= Seq(
"com.typesafe.akka" %% "akka-actor" % "2.4.0", // scala-steward:off
"com.typesafe.akka" %% "akka-testkit" % "2.5.0", // This and subsequent will get updated
)
```

0 comments on commit bc994eb

Please sign in to comment.
You can’t perform that action at this time.