Skip to content

[WOR-1502] Add dependabot configuration. #132

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

Merged
merged 1 commit into from
Feb 12, 2024
Merged

[WOR-1502] Add dependabot configuration. #132

merged 1 commit into from
Feb 12, 2024

Conversation

cahrens
Copy link
Contributor

@cahrens cahrens commented Feb 9, 2024

Added a configuration based off of WSM's configuration.

Copy link

sonarqubecloud bot commented Feb 9, 2024

Quality Gate Passed Quality Gate passed

Issues
0 New issues

Measures
0 Security Hotspots
No data about Coverage
No data about Duplication

See analysis details on SonarCloud

- "minor"
- "patch"
schedule:
interval: "monthly"
Copy link
Contributor Author

@cahrens cahrens Feb 9, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We wanted every 2 weeks, but that is not a supported option (options are daily, weekly, and monthly). I decided to go with monthly over weekly, but with a higher open pull request limit (20).

https://docs.github.com/en/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file#scheduleinterval

directory: "/"
open-pull-requests-limit: 20
groups:
minor-patch-dependencies:
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Group minor and patch updates together. Leave major updates as individual PRs since they are more likely to involve a breaking change. This way of grouping PRs has been working well for the Workspaces team.

timezone: "America/New_York"
target-branch: "main"
reviewers:
- "@DataBiosphere/platform-foundation-codeowners"
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

- "dependency"
- "gradle"
commit-message:
prefix: "[PF-2983]"
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Something we like to do is add labels which make the PR list a little more visual when viewing https://github.com/pulls/review-requested

Screenshot 2024-02-09 at 11 57 08 AM

There are other times when we manually do library updates so we reserve that prefix for dev-initiated PRs and a slightly different one for dependabot-initiated PRs.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@rushtong does the automatic linking to the JIRA ticket work with "-dependabot" appended?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It does link in our board.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OK, we can always tweak the prefix if people think it helps (I've always found that the titles and labels make it pretty clear).

commit-message:
prefix: "[PF-2983]"
ignore:
- dependency-name: "org.springframework.boot:spring-boot-gradle-plugin"
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I added an ignore based on the open PR, #130

@cahrens cahrens requested review from rushtong and a team February 9, 2024 16:26
Copy link
Contributor

@rushtong rushtong left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Everything looks reasonable to me 👍🏽

updates:
- package-ecosystem: "gradle"
directory: "/"
open-pull-requests-limit: 20

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we know how long the initial backlog is? Will 20 per month keep up with the pace of new arrivals?

Do you know how the top 20 updates will be sorted and chosen? (date created first? major first? ( / minor first?) / alphabetically first?)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I do not know how long the backlog is, but we can always adjust this if necessary. With the grouping of minor/patch, it's possible that 20 will be plenty.

I don't see anything in the documentation about how it decides the ordering (https://docs.github.com/en/code-security/dependabot/dependabot-version-updates/about-dependabot-version-updates#frequency-of-dependabot-pull-requests). Let me know if you find something!

Copy link
Contributor

@rtitle rtitle left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't have much experience configuring dependabot, but this looks good to me! Thanks for doing this @cahrens

@cahrens cahrens merged commit 517000d into develop Feb 12, 2024
@cahrens cahrens deleted the dependabot branch February 12, 2024 15:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants