chore(ci): ignore private repositories (esp. backstage app, backend) when release plugins

[christoph-jerolimov]

Hey, I just made a Pull Request!

This fixes #1508 by adding this configuration all changeset config.jsons:

  "privatePackages": {
    "tag": false,
    "version": false
  }

See changesets/changesets#1093 (comment) and https://github.com/changesets/changesets/blob/main/packages/cli/CHANGELOG.md#2251

I tried this locally in the npm package, which contains a changeset and a backstage app.

Without this ignore list it touches these files:

	deleted:    .changeset/proud-brooms-clean.md
	modified:   packages/app/package.json
	modified:   plugins/npm/package.json
	new:        packages/app/CHANGELOG.md
	new:        plugins/npm/CHANGELOG.md

With this change, it touches only:

	deleted:    .changeset/proud-brooms-clean.md
	modified:   plugins/npm/package.json
	new:        plugins/npm/CHANGELOG.md

I noticed that the changeset CLI crashes if a workspace contains only private packages and plugins. As discussed, I raise another PR to fix that for the npm plugin.

✔️ Checklist

• A changeset describing the change and affected packages. (more info)
• Added or updated documentation
• Tests for new functionality and regression tests for bug fixes
• Screenshots attached (for UI changes)
• All your commits have a Signed-off-by line in the message. (more info)

[04kash]

lgtm! Should we maybe document this in CONTRIBUTING.md that if someone includes an example app/backend they should add "ignore": ["app", "backend"] in the respective workspace's .changeset/config.json?

[awanlin]

Hi @jerolimov, thanks for running with this! I was wondering if would it be possible to leverage the private property in the package.json to drive this? Packages with private: true don't get published which in turn means they don't need to be versioned. Using this would mean that we don't have to manually maintain this list in the .changeset/config.json.

[04kash]

Some of them do have private: true but are still being included in the Version Packages PR. Eg: the app package in redhat-argocd has the private property set in package.json but was still included in this Version Packages PR

So I think setting the private property to true prevents the package from being published but a Version Packages PR is still made for it.

[christoph-jerolimov]

Yes, I had the same hope but couldn't find another solution yet.

As said, I also tried first to run yarn changeset version --ignore app --ignore backend, but it works only fine on projects with an backstage app, but fail on these without.

[awanlin]

Hi @jerolimov, I've since found this: changesets/changesets#1093 (comment). Can we try that instead, please?

If this works we should update this as well: https://github.com/backstage/community-plugins/blob/main/workspaces/repo-tools/packages/cli/src/lib/workspaces/.changeset/config.json

[christoph-jerolimov]

Hi @jerolimov, I've since found this: changesets/changesets#1093 (comment). Can we try that instead, please?

If this works we should update this as well: https://github.com/backstage/community-plugins/blob/main/workspaces/repo-tools/packages/cli/src/lib/workspaces/.changeset/config.json

Thanks, that's a better approche! I'm looking into this. But after adding

  "privatePackages": {
    "tag": false,
    "version": false
  }

with and without updating @changeset/cli it crashes:

[nix-shell:~/git/backstage/community-plugins/workspaces/npm]$ yarn changeset
🦋  error TypeError: Cannot read properties of undefined (reading 'packageJson')
🦋  error     at createChangeset (/home/christoph/git/backstage/community-plugins/workspaces/npm/node_modules/@changesets/cli/dist/changesets-cli.cjs.js:416:75)
🦋  error     at add (/home/christoph/git/backstage/community-plugins/workspaces/npm/node_modules/@changesets/cli/dist/changesets-cli.cjs.js:512:26)
🦋  error     at async run (/home/christoph/git/backstage/community-plugins/workspaces/npm/node_modules/@changesets/cli/dist/changesets-cli.cjs.js:1345:5)

I'll move this to a draft and keep you updated.

[awanlin]

Thanks for the detailed follow up @christoph-jerolimov! Let's go with this:

3. Keep the package private and remove the new attributes from workspaces/repo-tools/.changeset/config.json.

• We can still change the config.json for new workspaces.
• But the repo-tools is the only workspace with an unchanged config.json itself.

The repo-tool workspace is a special case and I think it's fine for now that it's not following this pattern.

[christoph-jerolimov]

Thanks for the detailed follow up @christoph-jerolimov! Let's go with this:

3. Keep the package private and remove the new attributes from workspaces/repo-tools/.changeset/config.json.

• We can still change the config.json for new workspaces.
• But the repo-tools is the only workspace with an unchanged config.json itself.

The repo-tool workspace is a special case and I think it's fine for now that it's not following this pattern.

I rebased this PR and applied this change. This mean

1. I removed the change from workspaces/repo-tools/.changeset/config.json
2. I reverted the change in workspaces/repo-tools/packages/cli/package.json so that it includes the private: true flag again
3. Kept the privatePackages flag in workspaces/repo-tools/packages/cli/src/lib/workspaces/.changeset/config.json
4. Added the flat also to the workspace workspaces/mend/.changeset/config.json

find . -name config.json | grep -v node_modules | grep changeset | wc -l
82


grep -E '"updateInternalDependencies": "patch",$' -r workspaces/*/.changeset | wc -l
80


grep -E '"updateInternalDependencies": "patch"$' -r workspaces/*/.changeset        
workspaces/repo-tools/.changeset/config.json:  "updateInternalDependencies": "patch"


grep -E '"updateInternalDependencies": "patch",$' workspaces/repo-tools/packages/cli/src/lib/workspaces/.changeset/config.json 
  "updateInternalDependencies": "patch",

Thanks for your patience and let me know if I should address something else.

[christoph-jerolimov]

@awanlin can you take a fresh look? Thanks :)

[awanlin]

Hi @christoph-jerolimov, something seems to have gone wrong or I misunderstood the direction forward. None of the changes in this PR are using privatePackages and they are all still using ignore, also there are no repo-tool or mend changes. Can you take another look, please?

[christoph-jerolimov]

Oh what a shame. Sorry, i switched between my pc and notebook and it looks like I rebased the old version. I will take a look later today.

[backstage-goalie]

Changed Packages

Package Name	Package Path	Changeset Bump	Current Version
@backstage-community/cli	workspaces/repo-tools/packages/cli	none	v0.0.3

[christoph-jerolimov]

Oh what a shame. Sorry, i switched between my pc and notebook and it looks like I rebased the old version. I will take a look later today.

Fixed. (Rebased on the right machine. Code reviews are a life saver.)

[awanlin]

Super close, if you can just remove the repo-tools changeset then we should be good to merge.

[christoph-jerolimov]

Super close, if you can just remove the repo-tools changeset then we should be good to merge.

Sure. I've removed the file and rebased the branch. 🤞

[awanlin]

Alright, let's get this in place. Thanks again for all your work back and forth on this @christoph-jerolimov 🙏