Verify the example .scala-steward.conf

[fthomas]

This checks that the example .scala-steward.conf in the docs is equivalent to the JSON one gets when parsing, decoding and encoding that example. It ensures that the values used in the example are the same as the values in the decoded RepoConfig.

With this change, the docs/mdoc task fails currently with:

error: repo-specific-configuration.md:211:1: Diff between parsed input (-) and encoded object (+):
         "groupId" : "com.example",
-        "version" : "2."
+        "version" : {
+          "prefix" : "2."
+        }
       },
       "pullRequests" : {
-        "frequency" : "30 day"
+        "frequency" : "30 days"
       }
       "pullRequests" : {
-        "frequency" : "14 day"
+        "frequency" : "14 days"
       }
   "signoffCommits" : true,
-  "updatePullRequests" : "always | on-conflicts | never",
+  "updatePullRequests" : "on-conflicts",
   "updates" : {
         "groupId" : "org.acme",
-        "version" : "1.0"
+        "version" : {
+          "prefix" : "1.0"
+        }
       }
         "groupId" : "com.example",
-        "version" : "1.1."
+        "version" : {
+          "prefix" : "1.1."
+        }
       }

In subsequent commits I'll will fix these reported differences.

Closes: #1341

[fthomas]

a99bde2 reduces the diff to:

error: repo-specific-configuration.md:211:1: Diff between parsed input (-) and encoded object (+):
         "groupId" : "com.example",
-        "version" : "2."
+        "version" : {
+          "prefix" : "2."
+        }
       },
   "signoffCommits" : true,
-  "updatePullRequests" : "always | on-conflicts | never",
+  "updatePullRequests" : "on-conflicts",
   "updates" : {
         "groupId" : "org.acme",
-        "version" : "1.0"
+        "version" : {
+          "prefix" : "1.0"
+        }
       }
         "groupId" : "com.example",
-        "version" : "1.1."
+        "version" : {
+          "prefix" : "1.1."
+        }
       }

[fthomas]

f3c58cc reduces the diff to:

error: repo-specific-configuration.md:211:1: Diff between parsed input (-) and encoded object (+):
   "signoffCommits" : true,
-  "updatePullRequests" : "always | on-conflicts | never",
+  "updatePullRequests" : "on-conflicts",
   "updates" : {

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 89.81%. Comparing base (3f58890) to head (c8743ba).
Report is 5 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #3571      +/-   ##
==========================================
+ Coverage   89.79%   89.81%   +0.01%     
==========================================
  Files         174      174              
  Lines        5029     5038       +9     
  Branches      491      489       -2     
==========================================
+ Hits         4516     4525       +9     
  Misses        513      513              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[fthomas]

This machinery also detects typos in the example options like this:

--- a/modules/docs/mdoc/repo-specific-configuration.md
+++ b/modules/docs/mdoc/repo-specific-configuration.md
@@ -144,7 +144,7 @@ updates.fileExtensions = [".scala", ".sbt", ".sbt.shared", ".sc", ".yml", ".md",
 # you don't change it yourself.
 # If "never", Scala Steward will never update the PR
 # Default: ${PullRequestUpdateStrategy.default.asJson.noSpaces}
-updatePullRequests = "always"
+updatePullRequest = "always"

which results in a build failure:

error: repo-specific-configuration.md:211:1: Diff between parsed input (-) and encoded object (+):
   "signoffCommits" : true,
-  "updatePullRequest" : "always",
   "updates" : {

The encoded RepoConfig has no updatePullRequest field because that field does not exist.

[mzuehlke]

Less likely to sneak in typos in the future 😄