Skip to content

Commit 00f7dab

Browse files
committed
Add links to PRs labelled with artifact-migrations
See scala-steward-org#3221
1 parent b6162bc commit 00f7dab

File tree

6 files changed

+34
-18
lines changed

6 files changed

+34
-18
lines changed

docs/artifact-migrations.md

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,22 @@
22

33
Scala Steward can not only bump versions but also change groupId and/or artifactIds if they have been renamed.
44

5-
An example pull request that demonstrates this feature is https://github.com/scala-steward-org/scala-steward/pull/2264/files which not only bumped the version but also changed the groupId.
5+
Here is a pull request that demonstrate this feature:
6+
7+
* https://github.com/scala-steward-org/scala-steward/pull/2264/files
8+
9+
More pull requests where Scala Steward applied artifact migrations can be found here:
10+
11+
* [Created pull requests](https://github.com/search?q=author%3Ascala-steward+is%3Apr+artifact-migrations&type=pullrequests)
12+
([compact]( https://github.com/pulls?q=author%3Ascala-steward+is%3Apr+artifact-migrations))
13+
* [Merged pull requests]( https://github.com/search?q=author%3Ascala-steward+is%3Amerged+sort%3Aupdated-desc+artifact-migrations&type=pullrequests)
14+
([compact]( https://github.com/pulls?q=author%3Ascala-steward+is%3Amerged+sort%3Aupdated-desc+artifact-migrations))
615

716
## How does this work?
817

918
Scala Steward contains a list of [artifact migrations][migrations] that maps old groupIds and/or artifactIds to their new values.
1019
When an artifact migration for a dependency exists, Scala Steward will look for new versions with the old **and** new groupIds and artifactIds.
11-
If it finds a suitable newer version with the new groupId/artifactId, it will consider it an update of that dependency and change the artifactId/groupId accordingly.
20+
If it finds a suitable newer version with the new groupId/artifactId, it will consider it an update of that dependency and change the groupId/artifactId accordingly.
1221

1322
## Adding artifact migrations to Scala Steward
1423

docs/help.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -63,9 +63,9 @@ Options and flags:
6363
--disable-default-repo-config
6464
Whether to disable the default repo config file
6565
--scalafix-migrations <uri>
66-
Additional scalafix migrations configuration file (can be used multiple times)
66+
Additional Scalafix migrations configuration file (can be used multiple times)
6767
--disable-default-scalafix-migrations
68-
Whether to disable the default scalafix migration file; default: false
68+
Whether to disable the default Scalafix migration file; default: false
6969
--artifact-migrations <uri>
7070
Additional artifact migration configuration file (can be used multiple times)
7171
--disable-default-artifact-migrations

docs/scalafix-migrations.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,15 +7,14 @@ would not compile with the new version of the dependency.
77

88
Here are two pull requests that demonstrate this feature:
99

10+
* https://github.com/coursier/versions/pull/25
1011
* https://github.com/barambani/http4s-extend/pull/67/files
11-
* https://github.com/fthomas/scalafix-test/pull/6/files
1212

13-
And here are all pull requests where Scala Steward applied Scalafix
14-
migrations:
13+
More pull requests where Scala Steward applied Scalafix migrations can be found here:
1514

16-
* [Created pull requests](https://github.com/search?q=author%3Ascala-steward+is%3Apr+scalafix-migrations)
15+
* [Created pull requests](https://github.com/search?q=author%3Ascala-steward+is%3Apr+scalafix-migrations&type=pullrequests)
1716
([compact]( https://github.com/pulls?q=author%3Ascala-steward+is%3Apr+scalafix-migrations))
18-
* [Merged pull requests]( https://github.com/search?q=author%3Ascala-steward+is%3Amerged+sort%3Aupdated-desc+scalafix-migrations)
17+
* [Merged pull requests]( https://github.com/search?q=author%3Ascala-steward+is%3Amerged+sort%3Aupdated-desc+scalafix-migrations&type=pullrequests)
1918
([compact]( https://github.com/pulls?q=author%3Ascala-steward+is%3Amerged+sort%3Aupdated-desc+scalafix-migrations))
2019

2120
## How does this work?

modules/core/src/main/scala/org/scalasteward/core/application/Cli.scala

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -217,13 +217,13 @@ object Cli {
217217
private val scalafixMigrations: Opts[List[Uri]] =
218218
options[Uri](
219219
"scalafix-migrations",
220-
s"Additional scalafix migrations configuration file $multiple"
220+
s"Additional Scalafix migrations configuration file $multiple"
221221
).orEmpty
222222

223223
private val disableDefaultScalafixMigrations: Opts[Boolean] =
224224
flag(
225225
"disable-default-scalafix-migrations",
226-
"Whether to disable the default scalafix migration file; default: false"
226+
"Whether to disable the default Scalafix migration file; default: false"
227227
).orFalse
228228

229229
private val scalafixCfg: Opts[ScalafixCfg] =

modules/docs/mdoc/artifact-migrations.md

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,22 @@
22

33
Scala Steward can not only bump versions but also change groupId and/or artifactIds if they have been renamed.
44

5-
An example pull request that demonstrates this feature is https://github.com/scala-steward-org/scala-steward/pull/2264/files which not only bumped the version but also changed the groupId.
5+
Here is a pull request that demonstrate this feature:
6+
7+
* https://github.com/scala-steward-org/scala-steward/pull/2264/files
8+
9+
More pull requests where Scala Steward applied artifact migrations can be found here:
10+
11+
* [Created pull requests](https://github.com/search?q=author%3Ascala-steward+is%3Apr+artifact-migrations&type=pullrequests)
12+
([compact]( https://github.com/pulls?q=author%3Ascala-steward+is%3Apr+artifact-migrations))
13+
* [Merged pull requests]( https://github.com/search?q=author%3Ascala-steward+is%3Amerged+sort%3Aupdated-desc+artifact-migrations&type=pullrequests)
14+
([compact]( https://github.com/pulls?q=author%3Ascala-steward+is%3Amerged+sort%3Aupdated-desc+artifact-migrations))
615

716
## How does this work?
817

918
Scala Steward contains a list of [artifact migrations][migrations] that maps old groupIds and/or artifactIds to their new values.
1019
When an artifact migration for a dependency exists, Scala Steward will look for new versions with the old **and** new groupIds and artifactIds.
11-
If it finds a suitable newer version with the new groupId/artifactId, it will consider it an update of that dependency and change the artifactId/groupId accordingly.
20+
If it finds a suitable newer version with the new groupId/artifactId, it will consider it an update of that dependency and change the groupId/artifactId accordingly.
1221

1322
## Adding artifact migrations to Scala Steward
1423

modules/docs/mdoc/scalafix-migrations.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,15 +7,14 @@ would not compile with the new version of the dependency.
77

88
Here are two pull requests that demonstrate this feature:
99

10+
* https://github.com/coursier/versions/pull/25
1011
* https://github.com/barambani/http4s-extend/pull/67/files
11-
* https://github.com/fthomas/scalafix-test/pull/6/files
1212

13-
And here are all pull requests where Scala Steward applied Scalafix
14-
migrations:
13+
More pull requests where Scala Steward applied Scalafix migrations can be found here:
1514

16-
* [Created pull requests](https://github.com/search?q=author%3Ascala-steward+is%3Apr+scalafix-migrations)
15+
* [Created pull requests](https://github.com/search?q=author%3Ascala-steward+is%3Apr+scalafix-migrations&type=pullrequests)
1716
([compact]( https://github.com/pulls?q=author%3Ascala-steward+is%3Apr+scalafix-migrations))
18-
* [Merged pull requests]( https://github.com/search?q=author%3Ascala-steward+is%3Amerged+sort%3Aupdated-desc+scalafix-migrations)
17+
* [Merged pull requests]( https://github.com/search?q=author%3Ascala-steward+is%3Amerged+sort%3Aupdated-desc+scalafix-migrations&type=pullrequests)
1918
([compact]( https://github.com/pulls?q=author%3Ascala-steward+is%3Amerged+sort%3Aupdated-desc+scalafix-migrations))
2019

2120
## How does this work?

0 commit comments

Comments
 (0)