add requirement and detection that breaking changes are explained in release notes #586
Conversation
IanButterworth
force-pushed
the
ib/breaking_change_explanation
branch
from
0632250 to
6f3de32
Compare
There was a problem hiding this comment.
Can we add a kwarg to the public interface (AutoMerge.run()) that allows users to opt-out of this guideline. I can imagine a situation where people are using AutoMerge internally for their private registry, and maybe they have a different internal system for NEWS, release notes, etc., and thus they don't want their internal AutoMerge to enforce a particular style.
|
This may have coverage already, I've kicked off the integration tests (via workflow dispatch), we can see if they fail. If so we will need to figure out how to adjust them to get the release notes in there somehow. The way integration tests work here is they run when the PR is in the merge queue, or by workflow dispatch by a maintainer. They take ~1 hour, and run on a live registry on github. |
|
Currently this only fails if the |
|
@ericphanson sorry I think it needs re-invoking as there was a bug before. |
I think this should be OK as registrator adds the label, so it should be before RegistryCI queries github for the PR. I guess if Registrator is quite slow and RegistryCI is fast though, there is nothing guaranteeing that ordering. We might be safer if we query for the labels inside the guideline itself instead of relying on |
|
Makes sense. Updated. |
|
This looks good to me, the only thing left is @DilumAluthge's request here and getting CI working |
Co-authored-by: Eric Hanson <5846501+ericphanson@users.noreply.github.com>
There was a problem hiding this comment.
LGTM!
Can you bump the patch version? Then feel free to add to the merge queue and register.
On General's side, once its registered, to make use of it we will need to run the update-manifests workflow (https://github.com/JuliaRegistries/General/blob/master/.github/workflows/update_manifests.yml) then add the kwarg.
|
Looks great, thanks for the help @ericphanson ! |
|
Good to go from my perspective. |
Helps get explanations of breaking changes into General PRs and ultimately TagBot-created releases.