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

christoph-jerolimov · 2024-10-10T15:20:48Z

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 · 2024-10-17T02:50:58Z

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 · 2024-10-17T05:12:48Z

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 · 2024-10-19T22:04:49Z

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 · 2024-10-24T12:47:32Z

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

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 · 2024-10-26T22:24:51Z

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

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

I removed the change from workspaces/repo-tools/.changeset/config.json
I reverted the change in workspaces/repo-tools/packages/cli/package.json so that it includes the private: true flag again
Kept the privatePackages flag in workspaces/repo-tools/packages/cli/src/lib/workspaces/.changeset/config.json
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 · 2024-10-29T08:57:20Z

@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 · 2024-10-29T14:52:26Z

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 · 2024-10-29T16:49:00Z

Changed Packages

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

christoph-jerolimov · 2024-10-29T16:50:16Z

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.

workspaces/repo-tools/.changeset/proud-ducks-knock.md

…when release plugins Signed-off-by: Christoph Jerolimov <[email protected]>

christoph-jerolimov · 2024-11-02T20:40:01Z

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 🙏

christoph-jerolimov requested review from Xantier, a team, yashoswalyo, karthikjeeyar, kuangp, JessicaJHee and awanlin as code owners October 10, 2024 15:20

christoph-jerolimov force-pushed the ignore-backstage-apps-and-backends branch from 29a2193 to 114c31a Compare October 10, 2024 15:24

christoph-jerolimov mentioned this pull request Oct 15, 2024

Org Member: christoph-jerolimov backstage/community#160

Closed

1 task

04kash approved these changes Oct 16, 2024

View reviewed changes

awanlin reviewed Oct 16, 2024

View reviewed changes

christoph-jerolimov mentioned this pull request Oct 17, 2024

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

Closed

2 tasks

awanlin requested changes Oct 18, 2024

View reviewed changes

awanlin mentioned this pull request Oct 18, 2024

plugin(npm): create a standalone demo application for npm plugin #1516

Merged

5 tasks

christoph-jerolimov marked this pull request as draft October 19, 2024 22:05

christoph-jerolimov force-pushed the ignore-backstage-apps-and-backends branch from 114c31a to 2997439 Compare October 19, 2024 22:31

christoph-jerolimov changed the title ~~fix(ci): ignore backstage app, app-next (if exist) and backend packages when release plugins~~ chore(ci): ignore private repositories (esp. backstage app, backend) when release plugins Oct 19, 2024

christoph-jerolimov marked this pull request as ready for review October 19, 2024 22:32

christoph-jerolimov requested review from andrewthauer, jmezach, schultzp2020, BethGriggs, gregorytalita, erikengervall, a team and alde as code owners October 19, 2024 22:32

christoph-jerolimov force-pushed the ignore-backstage-apps-and-backends branch from e49cdd0 to 9665078 Compare October 22, 2024 13:56

christoph-jerolimov force-pushed the ignore-backstage-apps-and-backends branch from 9665078 to 10bb718 Compare October 26, 2024 22:16

christoph-jerolimov requested a review from awanlin October 26, 2024 22:25

christoph-jerolimov force-pushed the ignore-backstage-apps-and-backends branch 3 times, most recently from 40174f1 to a1cc6ee Compare October 29, 2024 08:56

awanlin requested changes Oct 29, 2024

View reviewed changes

christoph-jerolimov force-pushed the ignore-backstage-apps-and-backends branch from a1cc6ee to 8279e37 Compare October 29, 2024 16:48

christoph-jerolimov requested review from ciiay and riginoommen as code owners October 29, 2024 16:48

christoph-jerolimov requested a review from awanlin October 29, 2024 16:50

awanlin requested changes Oct 31, 2024

View reviewed changes

workspaces/repo-tools/.changeset/proud-ducks-knock.md Outdated Show resolved Hide resolved

chore(ci): ignore private repositories (esp. backstage app, backend) …

af4f860

…when release plugins Signed-off-by: Christoph Jerolimov <[email protected]>

christoph-jerolimov force-pushed the ignore-backstage-apps-and-backends branch from 8279e37 to af4f860 Compare November 2, 2024 20:38

christoph-jerolimov requested a review from awanlin November 2, 2024 20:39

awanlin approved these changes Nov 4, 2024

View reviewed changes

Merge branch 'main' into ignore-backstage-apps-and-backends

f2f554a

awanlin enabled auto-merge (squash) November 4, 2024 16:40

awanlin merged commit e5cd1d3 into backstage:main Nov 4, 2024
251 checks passed

christoph-jerolimov deleted the ignore-backstage-apps-and-backends branch November 4, 2024 20:06

christoph-jerolimov mentioned this pull request Nov 4, 2024

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

Merged

5 tasks

christoph-jerolimov self-assigned this Nov 6, 2024

christoph-jerolimov mentioned this pull request Nov 16, 2024

chore(ci): ignore private repositories (esp. backstage app, backend) when release plugins redhat-developer/rhdh-plugins#40

Merged

4 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

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

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

christoph-jerolimov commented Oct 10, 2024 •

edited

Loading

04kash left a comment

awanlin left a comment

04kash commented Oct 17, 2024 •

edited

Loading

christoph-jerolimov commented Oct 17, 2024

awanlin left a comment •

edited

Loading

christoph-jerolimov commented Oct 19, 2024

awanlin commented Oct 24, 2024

christoph-jerolimov commented Oct 26, 2024 •

edited

Loading

christoph-jerolimov commented Oct 29, 2024

awanlin left a comment

christoph-jerolimov commented Oct 29, 2024

backstage-goalie bot commented Oct 29, 2024 •

edited

Loading

christoph-jerolimov commented Oct 29, 2024

awanlin left a comment

christoph-jerolimov commented Nov 2, 2024

awanlin left a comment

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

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

Conversation

christoph-jerolimov commented Oct 10, 2024 • edited Loading

Hey, I just made a Pull Request!

✔️ Checklist

04kash left a comment

Choose a reason for hiding this comment

awanlin left a comment

Choose a reason for hiding this comment

04kash commented Oct 17, 2024 • edited Loading

christoph-jerolimov commented Oct 17, 2024

awanlin left a comment • edited Loading

Choose a reason for hiding this comment

christoph-jerolimov commented Oct 19, 2024

awanlin commented Oct 24, 2024

christoph-jerolimov commented Oct 26, 2024 • edited Loading

christoph-jerolimov commented Oct 29, 2024

awanlin left a comment

Choose a reason for hiding this comment

christoph-jerolimov commented Oct 29, 2024

backstage-goalie bot commented Oct 29, 2024 • edited Loading

Changed Packages

christoph-jerolimov commented Oct 29, 2024

awanlin left a comment

Choose a reason for hiding this comment

christoph-jerolimov commented Nov 2, 2024

awanlin left a comment

Choose a reason for hiding this comment

christoph-jerolimov commented Oct 10, 2024 •

edited

Loading

04kash commented Oct 17, 2024 •

edited

Loading

awanlin left a comment •

edited

Loading

christoph-jerolimov commented Oct 26, 2024 •

edited

Loading

backstage-goalie bot commented Oct 29, 2024 •

edited

Loading