Skip to content
This repository has been archived by the owner on May 22, 2024. It is now read-only.

Replace .npmignores with file field #926

Merged
merged 3 commits into from
Feb 14, 2024
Merged

Replace .npmignores with file field #926

merged 3 commits into from
Feb 14, 2024

Conversation

sdadn
Copy link
Contributor

@sdadn sdadn commented Nov 6, 2023

Summary

This PR replaces .npmignore files with the files prop to denote what files will be published. The .npmignore works by blacklisting files, while files works by whitelisting files to be published. This change was made as it is more convenient to keep track of files that need to be published than finding potential files that don't need to be published. It also results in fewer issues when running npm pack locally.

Testing

This change was tested using:

  • WDIO
  • Jest
  • Visual testing (please attach a screenshot or recording)
  • Other (please describe below)
  • No tests are needed

This was tested by running npm pack on terra-clinical-header and verifying that all necessary files are included:

CleanShot 2023-11-06 at 17 29 25

Reviews

In addition to engineering reviews, this PR needs:

  • UX review
  • Accessibility review
  • Functional review

Additional Details

This PR resolves:

UXPLATFORM-XXXX


Thank you for contributing to Terra.
@cerner/terra

@sdadn sdadn self-assigned this Nov 6, 2023
Copy link
Contributor

github-actions bot commented Nov 6, 2023

Fails
🚫 Please include a CHANGELOG entry for each changed package this PR. Looks like a CHANGELOG entry is missing for:
  • terra-clinical-data-grid
  • terra-clinical-detail-view
  • terra-clinical-header
  • terra-clinical-item-display
  • terra-clinical-item-view
  • terra-clinical-label-value-view
  • terra-clinical-onset-picker
  • terra-clinical-result

Generated by 🚫 dangerJS against ca17ef0

@sycombs
Copy link
Contributor

sycombs commented Nov 6, 2023

Is there any way we can test this with terra-ui before releasing? (To ensure that we've whitelisted all the files needed for the site to build.)

Copy link
Contributor

stale bot commented Jan 6, 2024

This issue has been automatically marked as inactive because it has not had recent activity. It will be closed in seven days if no further activity occurs. Thank you for your contributions.

@stale stale bot added the inactive label Jan 6, 2024
@stale stale bot closed this Jan 13, 2024
@sdadn sdadn removed the inactive label Feb 14, 2024
@sdadn sdadn reopened this Feb 14, 2024
@github-actions github-actions bot temporarily deployed to preview-pr-926 February 14, 2024 17:10 Destroyed
@sdadn
Copy link
Contributor Author

sdadn commented Feb 14, 2024

Is there any way we can test this with terra-ui before releasing? (To ensure that we've whitelisted all the files needed for the site to build.)

@sycombs Good call!

Used npm pack to all the packages locally and tested by running the dev-site on terra-ui:

CleanShot 2024-02-14 at 12 38 08@2x

CleanShot 2024-02-14 at 12 40 05@2x

CleanShot 2024-02-14 at 12 40 39@2x

@sdadn
Copy link
Contributor Author

sdadn commented Feb 14, 2024

Fails
🚫 Please include a CHANGELOG entry for each changed package this PR. Looks like a CHANGELOG entry is missing for:

  • terra-clinical-data-grid
  • terra-clinical-detail-view
  • terra-clinical-header
  • terra-clinical-item-display
  • terra-clinical-item-view
  • terra-clinical-label-value-view
  • terra-clinical-onset-picker
  • terra-clinical-result

Generated by 🚫 dangerJS against ca17ef0

CHANGELOG updates are not needed.

@sdadn sdadn merged commit 8710721 into main Feb 14, 2024
41 of 43 checks passed
@sdadn sdadn deleted the add-files-props branch February 14, 2024 20:52
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants