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

Replace .npmignores with the file field #2034

Merged
merged 6 commits into from
Feb 15, 2024
Merged

Replace .npmignores with the file field #2034

merged 6 commits into from
Feb 15, 2024

Conversation

sdadn
Copy link
Contributor

@sdadn sdadn commented Feb 15, 2024

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. E.g.

CleanShot 2024-02-15 at 11 00 31

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 Feb 15, 2024
Copy link
Contributor

Fails
🚫 Please include a CHANGELOG entry for each changed package this PR. Looks like a CHANGELOG entry is missing for:
  • terra-abstract-modal
  • terra-aggregator
  • terra-application-header-layout
  • terra-application-layout
  • terra-application-links
  • terra-application-menu-layout
  • terra-application-name
  • terra-application-navigation
  • terra-application-utility
  • terra-brand-footer
  • terra-collapsible-menu-view
  • terra-compact-interactive-list
  • terra-data-grid
  • terra-date-input
  • terra-date-picker
  • terra-date-time-picker
  • terra-dialog-modal
  • terra-disclosure-manager
  • terra-embedded-content-consumer
  • terra-file-path
  • terra-folder-tree
  • terra-form-validation
  • terra-framework-docs
  • terra-hookshot
  • terra-infinite-list
  • terra-layout
  • terra-menu
  • terra-modal-manager
  • terra-navigation-layout
  • terra-navigation-prompt
  • terra-navigation-side-menu
  • terra-notification-dialog
  • terra-pills
  • terra-popup
  • terra-slide-group
  • terra-slide-panel-manager
  • terra-slide-panel
  • terra-slider
  • terra-table
  • terra-tabs
  • terra-theme-context
  • terra-theme-properties
  • terra-theme-provider
  • terra-time-input

Generated by 🚫 dangerJS against dc7671e

@github-actions github-actions bot temporarily deployed to preview-pr-2034 February 15, 2024 17:08 Destroyed
@sdadn
Copy link
Contributor Author

sdadn commented Feb 15, 2024

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

  • terra-abstract-modal
  • terra-aggregator
  • terra-application-header-layout
  • terra-application-layout
  • terra-application-links
  • terra-application-menu-layout
  • terra-application-name
  • terra-application-navigation
  • terra-application-utility
  • terra-brand-footer
  • terra-collapsible-menu-view
  • terra-compact-interactive-list
  • terra-data-grid
  • terra-date-input
  • terra-date-picker
  • terra-date-time-picker
  • terra-dialog-modal
  • terra-disclosure-manager
  • terra-embedded-content-consumer
  • terra-file-path
  • terra-folder-tree
  • terra-form-validation
  • terra-framework-docs
  • terra-hookshot
  • terra-infinite-list
  • terra-layout
  • terra-menu
  • terra-modal-manager
  • terra-navigation-layout
  • terra-navigation-prompt
  • terra-navigation-side-menu
  • terra-notification-dialog
  • terra-pills
  • terra-popup
  • terra-slide-group
  • terra-slide-panel-manager
  • terra-slide-panel
  • terra-slider
  • terra-table
  • terra-tabs
  • terra-theme-context
  • terra-theme-properties
  • terra-theme-provider
  • terra-time-input

Generated by 🚫 dangerJS against dc7671e

CHANGELOG updates are not needed for this change.

@sdadn
Copy link
Contributor Author

sdadn commented Feb 15, 2024

Wdio failures are not related to this change.

@sdadn sdadn merged commit ec1670e into main Feb 15, 2024
10 of 22 checks passed
@sdadn sdadn deleted the replace-npmignore branch February 15, 2024 17:57
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