zmkfirmware / zmk

ZMK Firmware Repository
https://zmk.dev/
MIT License
2.82k stars 2.85k forks source link

chore: Config dependabot for grouped npm updates #2614

Closed caksoylar closed 1 week ago

caksoylar commented 2 weeks ago

Attempt to organize dependabot so that:

The resulting PRs can be seen at https://github.com/caksoylar/zmk/pulls Config reference: https://docs.github.com/en/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file

Open question/points for discussion:

Nick-Munnich commented 2 weeks ago

Definitely like the look of this.

* should we also have a separate major updates group for dev deps? or alternatively, remove minor+patch constraint?

I think as long as we have security alerts set up I don't see the need to update dev deps major versions through dependabot.

* should security updates be constrained to minor+patch?

No, I think security stuff is important enough that we should put in the work to update major versions when they occur.

* any need to create other groups for specific dependencies (e.g. `docusaurus*`)?

I think a docusaurus group would be nice, yeah.

* should we touch the GH actions ecosystem entry? I am not sure if it has prod/dev but we can create groups (with semver constraints)

No opinion.

caksoylar commented 2 weeks ago

I think a docusaurus group would be nice, yeah.

Looking at the non-dev list https://github.com/zmkfirmware/zmk/blob/main/docs/package.json#L17-L34, we can either do @docusaurus and others, or perhaps we can do the following as separate:

The dev dependencies also have a @docusaurus group but it seems too fine-grained to split that as well.

Nick-Munnich commented 2 weeks ago

I'd say do @docusaurus, but singling out tree-sitter would be good.

caksoylar commented 2 weeks ago

I decided to only split prod to three (docusaurus, tree-sitter, other) and didn't split tree-sitter group to major/minor+patch. Let's see if it looks better.

@joelspadin any opinions on tree-sitter deps specifically, or in general?

joelspadin commented 1 week ago

Splitting out the tree-sitter packages seems good to me. That hasn't hit 1.x yet, so any updates could potentially be breaking.