Problem description
If changes are made to the source file index.js they are not automatically causing dist/index.js to be updated, making the changes practically ineffective. GHA runs from dist/index.js as defined in:
DEVELOPMENT.md includes instructions to build, however this is in a section Testing against another repo.
Suggested fix
Add clear instructions to DEVELOPMENT.md concerning what to do after modifying index.js:
Before submitting a PR:
- Rebase your branch on the current
master branch
- In the root of the cloned repository execute
npm ci
- Execute
npm run format
- Execute
npm run build
- commit the results with
git
Once a PR is then submitted it causes tests to run against the modified Cypress GitHub Action using the .github/workflows.
Note: To avoid whitespace changes in dist/index.js due to Microsoft Windows line endings (CRLF), instead of Unix (LF), execute the above preferably on a Ubuntu platform (see vercel/ncc#992).
Edit: The new workflow .github/workflows/check-dist.yml now flags the error condition if dist/index.js does not match index.js.
Problem description
If changes are made to the source file index.js they are not automatically causing dist/index.js to be updated, making the changes practically ineffective. GHA runs from dist/index.js as defined in:
github-action/action.yml
Line 92 in 175fdad
DEVELOPMENT.md includes instructions to build, however this is in a section Testing against another repo.
Suggested fix
Add clear instructions to DEVELOPMENT.md concerning what to do after modifying index.js:
Before submitting a PR:
masterbranchnpm cinpm run formatnpm run buildgitOnce a PR is then submitted it causes tests to run against the modified Cypress GitHub Action using the .github/workflows.
Note: To avoid whitespace changes in dist/index.js due to Microsoft Windows line endings (CRLF), instead of Unix (LF), execute the above preferably on a Ubuntu platform (see vercel/ncc#992).
Edit: The new workflow .github/workflows/check-dist.yml now flags the error condition if dist/index.js does not match index.js.