community-plugins icon indicating copy to clipboard operation
community-plugins copied to clipboard

🔧 Repository: Renovate changesets on `devDependencies`

Open awanlin opened this issue 1 year ago • 3 comments

📜 Description

The renovate-changeset action is adding changesets for changes that are only devDependencies. When we merge these changes it then kicks off the version packages which we don't need in this case as the package hans't actually changed

This is properly not something that we fix in this repo but here: https://github.com/backstage/actions/tree/main/renovate-changesets, logging it here for visibility and so I don't forget about it.

👍 Expected behavior

There should be not changesets if the changes are just related to devDependencies

👎 Current Behavior

Changesets are added when there change is just for devDependencies

👟 Reproduction steps

Example PR here: https://github.com/backstage/community-plugins/pull/877

📃 Provide the context for the Bug.

I merged this PR - https://github.com/backstage/community-plugins/pull/877 - which then triggers a bunch of Version Packages PRs.

👀 Have you spent some time to check if this bug has been raised before?

  • [X] I checked and didn't find similar issue

🏢 Have you read the Code of Conduct?

Are you willing to submit PR?

No, but I'm happy to collaborate on a PR with someone else

awanlin avatar Aug 23 '24 19:08 awanlin

I'd like to take a look at this, can I be assigned to the issue?

04kash avatar Aug 30 '24 21:08 04kash

Hey @04kash, thanks - assigned

BethGriggs avatar Sep 10 '24 16:09 BethGriggs

Opened a PR for this issue here: https://github.com/backstage/actions/pull/159

04kash avatar Oct 09 '24 19:10 04kash

I'm not sure about this as in some cases a changeset might be required even for devDependencies bumps. It can also help debugging unexpected compatibility issues with releases to identify potential causes more quickly. The core Backstage packages also include bumps for devDependencies.

vinzscam avatar Nov 14 '24 22:11 vinzscam

I think for cases where a changeset for devDependencies is needed, they could be manually added to the Renovate PR. WDYT @vinzscam ?

04kash avatar Dec 11 '24 15:12 04kash

I also noticed that in this repo we seem to be using this script: https://github.com/backstage/community-plugins/blob/main/scripts/ci/generate-bump-changesets.js rather than the action mentioned in the issue for genrating renovate changesets. So I'd assume we need to make changes to the script instead?

04kash avatar Dec 12 '24 20:12 04kash

I think for cases where a changeset for devDependencies is needed, they could be manually added to the Renovate PR. WDYT @vinzscam ?

but this will add more work as we need to identify whether a dependency bump should be added, with all the risks mentioned in

I'm not sure about this as in some cases a changeset might be required even for devDependencies bumps. It can also help debugging unexpected compatibility issues with releases to identify potential causes more quickly. The core Backstage packages also include bumps for devDependencies.

what's a good advantage of skipping changesets for devDependencies?

vinzscam avatar Dec 13 '24 09:12 vinzscam

A good advantage of skipping changesets for devDependencies would be that it reduces unnecessary version bumps and keeps the changelog focused on changes that impact the package's functionality.

04kash avatar Jan 02 '25 18:01 04kash

Based on the general consensus during today's SIG meeting, we’ve decided to continue adding changesets for devDependencies. As such, I’ll be closing this issue.

04kash avatar Jan 28 '25 22:01 04kash