Add check for dist/ directory consistent with source files

[MikeMcC399]

This PR addresses issue #706 "Add build & diff "/dist" folder workflow".

It adds a new workflow .github/workflows/check-dist.yml which checks for consistency between source files and the generated contents of the master/dist directory.

If the source files and master/dist are consistent then the workflow succeeds.

If the source files and master/dist are not consistent then the workflow fails.

Verification

Test on Ubuntu 22.04.

Error case

Make a change to master/index.js, for instance, add the following to the top of the source code:

const workflowTest = true

Commit the change
Run the workflow .github/workflows/check-dist.yml
Check that the workflow fails, with the message:

"Detected uncommitted changes after build. See status below:"

Non-error case

Following on from above, execute:

npm run format
npm run build

Commit the change and retest.

Check that the workflow now succeeds.

Cross-platform compatibility

After achieving a successful result on Ubuntu 22.04 sync the branch from above onto a Windows 11 platform, then execute:

npm run format
npm run build

Confirm that there are no changes whilst ignoring end-of-line changes:

git diff --ignore-space-at-eol

and note the warnings:

warning: in the working copy of 'dist/thread.js', LF will be replaced by CRLF the next time Git touches it
warning: in the working copy of 'index.js', LF will be replaced by CRLF the next time Git touches it

Confirm that there are changes:

git diff

Commit these changes and retest.

Check that the workflow still succeeds despite having replaced the Ubuntu generated dist/index.js with a Windows generated version.

[MikeMcC399]

@jaffrepaul

• check-dist.yml succeeds according to run 7002051198
• I also successfully ran the manual tests that I described in the original post
• To complement this PR and provide documented guidance to contributors, the issue Incomplete build instructions in DEVELOPMENT.md #742 should also be addressed

This issue is ready for review and merge.

[MikeMcC399]

After gaining some practical experience with the workflow it should be considered for addition to the status checks in the branch protection rules.

[jaffrepaul]

Awesome, glad to see this addition. Should be very useful.

[MikeMcC399]

@jaffrepaul

Awesome, glad to see this addition. Should be very useful.

It should definitely catch the error condition if the update commands have not been executed:

npm run format
npm run build

[github-actions]

🎉 This PR is included in version 5.0.9 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀