feat(github): Add the possibility to link a Milestone #27343

nils-a · 2024-02-15T22:13:19Z

Changes

New configuration option: milestone.

This option is only available for the GitHub platform.
If set to the title of an existing milestone, the corresponding milestone is found and the PR is added to that milestone.
If a value is provided, but no corresponding milestone can be found, a warning is emitted to the log.

Context

#18372

Documentation (please check one with an [x])

I have updated the documentation, or
No documentation update is required

How I've tested my work (please select one)

I have verified these changes via:

Code inspection only, or
Newly added/modified unit tests, or
No unit tests but ran on a real repository, or
Both unit tests + ran on a real repository

nils-a · 2024-02-15T22:17:06Z

Does anyone have an idea for a better unit test? I feel the test I provided is not very "resilient" by expecting to get three api calls in the "correct" order.

to expect the log.warn

nils-a · 2024-02-15T23:38:40Z

At least GitLab, Gitea and Bitbucket seem to have the notions of milestones, too. Should I try to tackle them in this PR, too?

(I feel it would be "cleaner" to have single issues and PRs for each provider that should support the "milestone" option.)

lib/modules/platform/github/index.ts

viceice · 2024-02-16T14:43:19Z

At least GitLab, Gitea and Bitbucket seem to have the notions of milestones, too. Should I try to tackle them in this PR, too?

(I feel it would be "cleaner" to have single issues and PRs for each provider that should support the "milestone" option.)

Can be done in seperate PR's

lib/modules/platform/github/index.ts

lib/modules/platform/github/types.ts

docs/usage/configuration-options.md

better options documentation Co-authored-by: Michael Kriese <michael.kriese@visualon.de>

removed the unused param 'issueNo' removed the throw exception and logged a warning instead

moved the adding of the milestone to before automerging defined the milestone type using zod

…GH-18372 # Conflicts: # lib/config/options/index.ts

rarkins

What if we asked for the milestone number instead of title?

lib/modules/platform/github/index.ts

nils-a · 2024-02-17T06:41:54Z

That would remove the need to load and cache all milestones.

Should we, in that case, add an API call to check if the milestone exists and is open?

If we had the number, we could also try to set the milestone on the PR (without checking first) and simply log, if that fails.

rarkins · 2024-02-17T06:58:42Z

I'd prefer the happy path to be try setting it and log a warning if it fails

lib/modules/platform/github/index.ts

and merged addMilestone and tryAddMilestone

…GH-18372

docs/usage/configuration-options.md

lib/config/options/index.ts

Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com>

docs/usage/configuration-options.md

Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com>

HonkingGoose

One more thing, and then the docs are good to go.

docs/usage/configuration-options.md

Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com>

HonkingGoose

I'm happy with the docs now! 🥳

viceice · 2024-02-21T20:54:16Z

lib/config/options/index.ts

+  {
+    name: 'milestone',
+    description: `The number of a milestone. If set, the milestone will be set when Renovate creates the PR.`,
+    type: 'integer',


Why this was changed to integer this would make it probably hard to implemet on other platforms which don't use int as primary key.

it's also much harder to remember the id instead of the title-

viceice · 2024-02-21T20:56:46Z

That would remove the need to load and cache all milestones.

Should we, in that case, add an API call to check if the milestone exists and is open?

If we had the number, we could also try to set the milestone on the PR (without checking first) and simply log, if that fails.

I'm not happy with the switch to number 😞 . I know we don't need an additional lookup, but configuration is much harder.

renovate-release · 2024-02-21T21:41:48Z

🎉 This PR is included in version 37.204.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

nils-a · 2024-02-21T21:45:38Z

I'm not happy with the switch to number 😞 . I know we don't need an additional lookup, but configuration is much harder.

I agree, the configuration was much easier with the "title" of the milestone. However, having to load all the open milestones and find the one that matches the title didn't even feel good while typing it.

I am, however, totally prepared to add an alternative configuration option with the title if that is desired.

nils-a added 2 commits February 15, 2024 22:54

initial idea

fca2c5c

added a test

9488263

fix documentation lint-error

837d240

nils-a marked this pull request as ready for review February 15, 2024 22:29

nils-a marked this pull request as draft February 15, 2024 22:33

added a second test

5135b37

to expect the log.warn

nils-a marked this pull request as ready for review February 15, 2024 23:36

rarkins reviewed Feb 16, 2024

View reviewed changes

lib/modules/platform/github/index.ts Outdated Show resolved Hide resolved

lib/modules/platform/github/index.ts Outdated Show resolved Hide resolved

lib/modules/platform/github/index.ts Outdated Show resolved Hide resolved

viceice reviewed Feb 16, 2024

View reviewed changes

lib/modules/platform/github/index.ts Outdated Show resolved Hide resolved

lib/modules/platform/github/types.ts Outdated Show resolved Hide resolved

docs/usage/configuration-options.md Outdated Show resolved Hide resolved

nils-a and others added 6 commits February 16, 2024 20:04

Update docs/usage/configuration-options.md

ae836e4

better options documentation Co-authored-by: Michael Kriese <michael.kriese@visualon.de>

implemented changes suggested by rarkins

039593a

removed the unused param 'issueNo' removed the throw exception and logged a warning instead

implemented changes suggested by viceice

1b6a8a6

moved the adding of the milestone to before automerging defined the milestone type using zod

Merge remote-tracking branch 'upstream/main' into feature/renovatebot…

ebe665f

…GH-18372 # Conflicts: # lib/config/options/index.ts

add another unit test to cover the one missing line

6b91f16

fix linting issues

af4456d

nils-a requested review from viceice and rarkins February 16, 2024 22:05

rarkins requested changes Feb 17, 2024

View reviewed changes

lib/modules/platform/github/index.ts Outdated Show resolved Hide resolved

lib/modules/platform/github/index.ts Outdated Show resolved Hide resolved

viceice reviewed Feb 17, 2024

View reviewed changes

lib/modules/platform/github/index.ts Outdated Show resolved Hide resolved

switched from using the milestone title to the number

b3de7b6

rarkins requested changes Feb 18, 2024

View reviewed changes

lib/modules/platform/github/index.ts Show resolved Hide resolved

nils-a added 3 commits February 18, 2024 21:23

added a test for the 422 milestone error

e574d0a

and merged addMilestone and tryAddMilestone

Merge remote-tracking branch 'upstream/main' into feature/renovatebot…

d9f990f

…GH-18372

ignore coverage of a branch that is probably never reached

81d9893

nils-a requested a review from rarkins February 18, 2024 21:03

nils-a requested a review from viceice February 18, 2024 21:03

rarkins previously approved these changes Feb 19, 2024

View reviewed changes

HonkingGoose reviewed Feb 19, 2024

View reviewed changes

docs/usage/configuration-options.md Outdated Show resolved Hide resolved

HonkingGoose suggested changes Feb 19, 2024

View reviewed changes

lib/config/options/index.ts Outdated Show resolved Hide resolved

lib/config/options/index.ts Show resolved Hide resolved

nils-a dismissed rarkins’s stale review via 60db6c7 February 19, 2024 13:50

nils-a and others added 2 commits February 19, 2024 14:50

Update docs/usage/configuration-options.md

60db6c7

Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com>

Update lib/config/options/index.ts

4d2e1df

Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com>

rarkins previously approved these changes Feb 19, 2024

View reviewed changes

rarkins requested a review from HonkingGoose February 20, 2024 06:18

HonkingGoose reviewed Feb 21, 2024

View reviewed changes

docs/usage/configuration-options.md Outdated Show resolved Hide resolved

Update docs/usage/configuration-options.md

327d9e5

Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com>

rarkins dismissed their stale review via 327d9e5 February 21, 2024 09:19

HonkingGoose reviewed Feb 21, 2024

View reviewed changes

docs/usage/configuration-options.md Outdated Show resolved Hide resolved

docs/usage/configuration-options.md Outdated Show resolved Hide resolved

nils-a and others added 2 commits February 21, 2024 13:10

Update docs/usage/configuration-options.md

f0f1725

Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com>

Update docs/usage/configuration-options.md

40fdba8

Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com>

nils-a requested a review from HonkingGoose February 21, 2024 12:12

rarkins enabled auto-merge February 21, 2024 12:34

rarkins approved these changes Feb 21, 2024

View reviewed changes

rarkins added this pull request to the merge queue Feb 21, 2024

rarkins removed this pull request from the merge queue due to a manual request Feb 21, 2024

HonkingGoose approved these changes Feb 21, 2024

View reviewed changes

rarkins added this pull request to the merge queue Feb 21, 2024

viceice reviewed Feb 21, 2024

View reviewed changes

Merged via the queue into renovatebot:main with commit 16589bf Feb 21, 2024
35 checks passed

nils-a deleted the feature/GH-18372 branch February 21, 2024 21:45

github-actions bot locked as resolved and limited conversation to collaborators Mar 23, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(github): Add the possibility to link a Milestone #27343

feat(github): Add the possibility to link a Milestone #27343

nils-a commented Feb 15, 2024

nils-a commented Feb 15, 2024

nils-a commented Feb 15, 2024

viceice commented Feb 16, 2024

rarkins left a comment

nils-a commented Feb 17, 2024

rarkins commented Feb 17, 2024

HonkingGoose left a comment

HonkingGoose left a comment

viceice Feb 21, 2024

viceice commented Feb 21, 2024

renovate-release commented Feb 21, 2024

nils-a commented Feb 21, 2024

feat(github): Add the possibility to link a Milestone #27343

feat(github): Add the possibility to link a Milestone #27343

Conversation

nils-a commented Feb 15, 2024

Changes

Context

Documentation (please check one with an [x])

How I've tested my work (please select one)

nils-a commented Feb 15, 2024

nils-a commented Feb 15, 2024

viceice commented Feb 16, 2024

rarkins left a comment

Choose a reason for hiding this comment

nils-a commented Feb 17, 2024

rarkins commented Feb 17, 2024

HonkingGoose left a comment

Choose a reason for hiding this comment

HonkingGoose left a comment

Choose a reason for hiding this comment

viceice Feb 21, 2024

Choose a reason for hiding this comment

viceice commented Feb 21, 2024

renovate-release commented Feb 21, 2024

nils-a commented Feb 21, 2024