Add plugin for generating .mergify.yml config
#190
Conversation
This reverts commit 4a18377.
| - name: merge scala-steward's PRs | ||
| conditions: | ||
| - author=scala-steward | ||
| - or: | ||
| - body~=labels:.*early-semver-patch | ||
| - body~=labels:.*early-semver-minor | ||
| - status-success=Build and Test (ubuntu-latest, 2.12.15, temurin@8, rootJVM) | ||
| - '#approved-reviews-by>=1' |
There was a problem hiding this comment.
@fthomas if you have a chance, would appreciate your eyes on this. Are these labels the right configuration for checking steward PRs? Thanks! :)
| ThisBuild / mergifyStewardConfig ~= { _.map(_.copy(mergeMinors = true)) } | ||
| ThisBuild / mergifySuccessConditions += MergifyCondition.Custom("#approved-reviews-by>=1") |
There was a problem hiding this comment.
mergeMinors, because I'm dog-fooding. But I actually don't trust any update to upstream sbt plugins is not going to break things, patch or not ...
| .mapJson(l => Json.obj("label" -> l)) | ||
| } | ||
|
|
||
| private[this] object Dummy extends MergifyAction |
There was a problem hiding this comment.
This trick lets us keep MergifyAction sealed while being able to compatibly add additional cases to the ADT, since users will never be able to exhaustively pattern match.
|
Now, the question is how can I get mergify working on this repo 🤔 |
|
@Mergifyio refresh |
.mergify.yml
Outdated
| remove: [] | ||
| - name: Label github PRs | ||
| conditions: | ||
| - files~=^github |
There was a problem hiding this comment.
Hmm, this should end in /, or else it will pick up changes in github-actions as well.
|
This is a whopper, but the generated mergify config is valid (correct, idk 🙃). Once it's out in the wild we'll understand better how it works. I'll keep it stable for 0.4 but if necessary will change some stuff around in 0.5. |
|
You could have just used sbt-mergify-github-actions from https://github.com/nafg/mergify-yaml/ |
|
It autogenerates the case classes from the Mergify docs so it's complete |
|
@nafg cool! The hardest part while working on this one was expanding the matrix. Would appreciate any PRs to help with the |
|
Not sure I follow what you mean about expanding the matrix. But you could use mergify-writer as standalone library if you like. Like I said the case classes are autogenerated from Mergify docs. Or you could submit a PR improving the logic to my SBT plugin ;) Or if it's explained to me (and it doesn't already do it) then I could add it myself. |
|
How do I set it up? It looks like just adding the config is not enough. I also tried to install it from here: https://github.com/apps/mergify/installations/new but it's not working: typelevel/cats-tagless#336 |
|
@joroKr21 I also had trouble setting it up on my Typelevel repositories. But it seems to be working well in http4s/http4s-jdk-http-client#598. I think we need an org admin to enable it for us. |
This was originally proposed in sbt/sbt-github-actions#46.
Essentially, the problem is that in order to validate CI success the mergify config needs a list of all the jobs in the CI matrix with their exact names (including the Scala version) (mergify docs on this topic). In practice, manually keeping these in sync is annoying, and sbt-gh-actions is managing the build matrix anyway.
By default, the plugin includes a configuration to merge CI-passing PRs from scala-steward for patch updates. This can be further configured to include minor bumps and/or disabled.
Another idea I have is to generate config for auto-labeling of PRs based on file paths of affected modules, like http4s does. It'll be nice not to have to hand-maintain that.
Since this plugin is new, I'm keeping it as a separate module that has to be added explicitly to a build. It's still lacking DSL for many mergify features, but we can add them as required. It currently supports merging and labeling which are probably the most important.
Once it's proven itself we can consider if we want to include it in the sbt-typelevel super-plugin.