CI tests should fail if the working tree is unclean

[josephjclark]

A super common problem occurs when publishing packages:

• We build the project
• ast.json changes because someone (usually me!) forgot to rebuild docs before merging
• The publish step fails because there are uncommitted changes in the tree (ast.jso)

This can occur with package.json too

We need an extra step in our CI github action to validate after install & build that the working tree is clean. Otherwise we should fail.

[martalovescoffee]

@josephjclark is this a task for Mtuchi or Hunter or it's yours?

[josephjclark]

Sorry @martalovescoffee I missed this message. For the record this is a task for anyone

[mtuchi]

I think i need to sync with @josephjclark to understand how i can test this locally. Probably i need to use a tool to run the CI tests locally.

Maybe one of these

• https://github.com/nektos/act
• https://github.com/getlocalci/local-ci

[josephjclark]

No need for anything so complicated.

Just create a new script like test:git or something, which should fail if git status (or something better?) reports changes

That script should fail locally and in CI. You then just need to make sure that the build action uses it

You don't need to create/mock local github actions.

Maybe instead of creating a new script, you can extend an existing one