Fail the build if the yarn.lock file is changed after running yarn install

[gashcrumb]

What do you want to improve?

Often when running yarn install after updating the yarn.lock file contains changes.

What is the current behavior?

This is not ideal as it means there's inconsistencies between what folks are committing and what is being tested in github actions.

What will the new behavior be?

The build action will fail if there's changes to the yarn.lock file after running yarn install

See this comment for more information:

Yes this is a copy of janus-idp/backstage-plugins#1169

[nickboldt]

See https://issues.redhat.com//browse/RHIDP-1204 for updates.

PRs for this:

• chore(deps): fail the build if workspace dirty after a yarn install (yarn.lock changed) (RHIDP-1203, RHIDP-1204) #1175 (1.1.x)
• chore(deps): fail the build if workspace dirty after a yarn install (yarn.lock changed) (RHIDP-1203, RHIDP-1204) #1174 (main)

PR is failing already with

After 'yarn install', workspace is dirty! The following files have changed:

app-config.example.yaml
app-config.yaml
yarn.lock

-- https://github.com/janus-idp/backstage-showcase/actions/runs/8646895996/job/23707183425?pr=1174

and

After 'yarn install', workspace is dirty! The following files have changed:

app-config.example.yaml
app-config.yaml

-- https://github.com/janus-idp/backstage-showcase/actions/runs/8646912247/job/23707235821?pr=1175

Should we exclude app-config.* from the list of files that can be dirty during a release?

[gashcrumb]

I think not to be honest. For me it's a red flag that there's something going on that needs to be investigated. Or it indicates that an upgrade has migrated the configuration files, in which case I think that this kind of change to the files should be required to be included in a PR update as well.

[nickboldt]

so you're saying this is a GOOD and EXPECTED failure, and the change proposed by this PR is approved?

[gashcrumb]

yep 😄

[gashcrumb]

I take that back after looking at the PR action 😄 . Turns out the PR check build is copying the app config into place for some reason, so we should leave those two changed files as-is for now and just focus on the yarn.lock file.

[nickboldt]

PRs amended to only complain if a yarn.lock is changed.

• https://github.com/janus-idp/backstage-showcase/pull/1175/files#diff-daafae55647205597532a656ac71c4acb6c4c1e1629d6bd1b7cc0d0f4104b621R61
• https://github.com/janus-idp/backstage-showcase/pull/1174/files#diff-944291df2c9c06359d37cc8833d182d705c9e8c3108e7cfe132d61a06e9133ddR54

Can I get a 👍 on them now?

[nickboldt]

Woo! Snyk PRs are now failing with

After 'yarn install', workspace is dirty! The following files have changed:

app-config.example.yaml
app-config.yaml
yarn.lock

https://github.com/janus-idp/backstage-showcase/actions/runs/8661941105/job/23752905502?pr=1104

So... I'm going to resolve this.