Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

USWDS-Site - Documentation: Add note about incorrect package dates #2499

Closed
1 task done
Tracked by #5872
mahoneycm opened this issue Feb 21, 2024 · 1 comment · Fixed by #2621
Closed
1 task done
Tracked by #5872

USWDS-Site - Documentation: Add note about incorrect package dates #2499

mahoneycm opened this issue Feb 21, 2024 · 1 comment · Fixed by #2621
Assignees
Labels
Affects: Content Relates to content Type: Update A content update
Milestone

Comments

@mahoneycm
Copy link
Contributor

mahoneycm commented Feb 21, 2024

Summary

Add note about incorrect package dates to download page. Note provided by content strategy:

Note: The file date defaults to October 26, 1985, when you download and install this package. This is intentional. NPM sets a default date to ensure reproducible builds for npm packages.

Download and Documentation page updates 2-22-2024 (🔒)

Problem statement

NPM purposefully sets package dates to 10/26/1985 to ensure hash-identical tarballs no matter when or on what device the npm pack is ran. This can confuse users who inspect the package and see the incorrect files for the date.

Proposed Solution

Add note to site to specify this is intended behavior from NPM.

Affected pages

Download page →
Documentation page →

Related issue

Since the documentation page content is pulled from the USWDS README, we'll need to update the USWDS repo as well.

@mahoneycm mahoneycm self-assigned this Feb 21, 2024
@github-actions github-actions bot added the Status: Triage We're triaging this issue and grooming if necessary label Feb 21, 2024
@mahoneycm
Copy link
Contributor Author

Note provided by Content Strategy

Add the following note to the aforementioned pages:

Note: The file date defaults to October 26, 1985, when you download and install this package. This is intentional. NPM sets a default date to ensure reproducible builds for npm packages.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Affects: Content Relates to content Type: Update A content update
Projects
Status: Done
Development

Successfully merging a pull request may close this issue.

3 participants