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

🔧 Repository: Version job should skip the backstage apps (private npm packages)

Open christoph-jerolimov opened this issue 1 year ago • 1 comments

📜 Description

Some workspaces contains a backstage app that refers the included plugins. For each release process (Version ... PR) the app package.json was touched and the CHANGELOG.md of the app was extended. I guess that's not necessary.

Same happens for plugins with a backend plugin for the backend app.

I guess all this files can be removed:

ls -l workspaces/*/packages/{app,backend}/CHANGELOG.md

(33 CHANGELOG files)

👍 Expected behavior

Only the plugin code should be touched.

👎 Current Behavior

Also the packages app and backend are changed when a new release happen.

👟 Reproduction steps

Take a look in any Version PR for a plugin that contains a complete backstage app.

For example:

  • https://github.com/backstage/community-plugins/pull/1489
  • https://github.com/backstage/community-plugins/pull/1506

The app and backend package is marked as "private": true in their package.json. I guess this packages should be ignored.

📃 Provide the context for the Bug.

No response

👀 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?

Yes I am willing to submit a PR!

christoph-jerolimov avatar Oct 10 '24 12:10 christoph-jerolimov

I'm happy to take a look into the release/version process and I guess the starting point is this:

  • https://github.com/backstage/community-plugins/blob/main/.github/workflows/version-bump.yml#L103-L106
  • https://github.com/backstage/community-plugins/blob/main/scripts/ci/generate-version-bump-changeset.js

Right? If someone has any other hints, please let me know. :)

christoph-jerolimov avatar Oct 10 '24 12:10 christoph-jerolimov

The version bump scripts are to bump the package versions to use the latest backstage version. I think we'd want to make changes somewhere in this workflow https://github.com/backstage/community-plugins/blob/main/.github/workflows/release_workspace.yml

04kash avatar Oct 16 '24 18:10 04kash

Yep, thanks @04kash.

But applying general rules here https://github.com/backstage/community-plugins/blob/main/.github/workflows/release_workspace.yml#L98 will not because changeset will fail if you pass --ignore with a package that doesn't exist.

I know you saw it already, just if someone else starts reading here, that's the reason I opened #1510.

christoph-jerolimov avatar Oct 17 '24 07:10 christoph-jerolimov