Skip to content

Incomplete build instructions in DEVELOPMENT.md #742

@MikeMcC399

Description

@MikeMcC399

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:

main: 'dist/index.js'

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:

  1. Rebase your branch on the current master branch
  2. In the root of the cloned repository execute npm ci
  3. Execute npm run format
  4. Execute npm run build
  5. 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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions