Skip to content
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

chore: enable dependabot to update dependencies #8888

Merged
merged 1 commit into from Feb 23, 2024

Conversation

garethbowen
Copy link
Member

@garethbowen garethbowen commented Feb 20, 2024

Description

Attempt to enable dependabot to update dependencies automatically. This first version is a trial run. Further improvements would be to add configurations for the other package.json locations, add other registries like docker and gh actions, etc.

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

Code review checklist

  • Readable: Concise, well named, follows the style guide, documented if necessary.
  • Documented: Configuration and user documentation on cht-docs
  • Tested: Unit and/or e2e where appropriate
  • Internationalised: All user facing text
  • Backwards compatible: Works with existing data and configuration or includes a migration. Any breaking changes documented in the release notes.

Compose URLs

If Build CI hasn't passed, these may 404:

License

The software is provided under AGPL-3.0. Contributions to this project are accepted under the same license.

Copy link
Contributor

@mrjones-plip mrjones-plip left a comment

Choose a reason for hiding this comment

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

Nice! This might be a bit bumpy to get going (spam, false positives etc), but I think a welcome improvement in the long run.

Only question I have is I don't think we want to be bothered with major updates, yeah? Should we consider adding an update-types value to avoid that? I believe we'll need one of these for each of the three groups.

 update-types:
        - "minor"
        - "patch"

However, maybe this is OK b/c we'll get he PR opened and we can choose to ignore or schedule it?

See info on group declarations.

@garethbowen
Copy link
Member Author

Only question I have is I don't think we want to be bothered with major updates, yeah?

@mrjones-plip I find it quite confusing but there are two ways to configure dependabot. The first is just to deal with known vulnerabilities - that one is already turned on and pushed a bunch of PRs yesterday. This second one is for automatically updating for non-security related reasons. I was hoping this would eliminate the need for manually updating them which is slow and error prone. I think major updates still fit into this category, though we're really leaning heavily on our testing framework to catch anywhere the dependency has broken backwards compatibility in a way that affects us. I don't think the spam will be a serious problem because majors should be rare, and it's easy to add a library to the ignore list if the breaking change will take some effort to fix. At the very least it's one way to be notified when a new major drops for any of our dependencies!

I'm still leaning towards including majors and removing them later if it turns out to be a mistake (spam or fragility).

Copy link
Contributor

@mrjones-plip mrjones-plip left a comment

Choose a reason for hiding this comment

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

@garethbowen - yeah - I can get behind your thoughts around this and including majors. Ship it!

@garethbowen garethbowen merged commit fcac19e into master Feb 23, 2024
30 checks passed
@garethbowen garethbowen deleted the garethbowen-patch-2 branch February 23, 2024 17:34
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.

None yet

2 participants