-
-
Notifications
You must be signed in to change notification settings - Fork 55
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
ci(danger): Do not require changelogs from dependabot #714
Conversation
For plain dependency upgrades that require not changes we normally do not need any changelog entries. But not having them fails CI which renders every dependabot PR a huge hassle. Sadly we can not customise the dependabot PRs to add a #skip-changelog marker (see e.g. dependabot/dependabot-core#2091), so lets resort to changing the check instead. There is a risk that someone pushes some changes to such a PR that does require a changelog. Hopefully we'll recognise this and do the right thing anyway.
I would like not to have this. We need to review & approve every dependency bump anyway, and as part of that can add a #skip-changelog to the PR description. If dependabot overwrites the description, we should rather update our changelog bot to also check in comments. Now the actual reason why I would like to have this: In some cases we do want a changelog entry and it's too easy to forget. Especially for dependency upgrades that fix CVEs, come with user-visible changes, or in the case of |
So I describe the tradeoff made here pretty clearly: if you don't need to push any changes to the PR you won't need a changelog. But if you do make changes it won't prompt you. I think I could like the suggestion of looking in comments as well though, it would mean you can write:
and it'll just work. let me change it to that to try it out for a while |
The comment compromise sounds pretty sweet, if dependabot is graceful with the delay. Otherwise, we just comment #skip-changelog, and then merge with the large green button at the bottom. Counter example for checking for changes: getsentry/relay#1207 |
Look for #skip-changelog markers in the review comments instead.
PTAL |
We may have a problem now. Danger checks for a comment with (NB I'm not sure if reviews actually includes all comments or just "comment" reviews) |
Codecov Report
@@ Coverage Diff @@
## master #714 +/- ##
==========================================
- Coverage 73.63% 73.22% -0.42%
==========================================
Files 48 48
Lines 10698 10835 +137
==========================================
+ Hits 7878 7934 +56
- Misses 2820 2901 +81
Continue to review full report at Codecov.
|
FWIW the code in the PR currently checks top-level comments included in a review. Let's use #673 as an example: the review loop iterates over the entries returned by https://api.github.com/repos/getsentry/symbolicator/pulls/673/reviews. If you want to look at all comments, the endpoint (using the above PR) is actually https://api.github.com/repos/getsentry/symbolicator/issues/673/comments. If the intent is to scan through all comments, you probably want to invoke |
Also need to give this permission to write to the pull request again, seems like our org settings have been tightened and this could no longer write to the PR.
PTAL, this now only accepts |
For plain dependency upgrades that require not changes we normally do
not need any changelog entries. But not having them fails CI which
renders every dependabot PR a huge hassle.
Sadly we can not customise the dependabot PRs to add a #skip-changelog
marker (see e.g.
dependabot/dependabot-core#2091), so lets
resort to changing the check instead.
There is a risk that someone pushes some changes to such a PR that
does require a changelog. Hopefully we'll recognise this and do the
right thing anyway.
#skip-changelog