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

[Hotfix] Ensure CMS Design System npm package version is 2.5.0 #1408

Merged
merged 2 commits into from
Aug 21, 2024

Conversation

PhilR8
Copy link
Contributor

@PhilR8 PhilR8 commented Aug 21, 2024

Description

EREGCSC-2779 (Vitest fixes) introduced a regression where the CMS Design System npm package was updated to a newer minor version. Our targeted version is 2.5.0, but the pull request for 2779 rebuilt the package-lock.json file to install 2.13.0.

We don't want 2.13.0 because it includes unwanted style changes. Specifically, element focus styles are pink instead of blue.

We've previously attempted to upgrade to 2.13.0 based on a Snyk suggestion, but that upgrade was reverted back to 2.5.0 for this same reason.

Except we didn't actually lock the version to 2.5.0. Note this line from package.json:

"@cmsgov/design-system": "^2.5.0",

The caret (^) before the version indicates that minor (0.X) and patch (0.0.X) versions can be updated if available and compatible. See NPM documentation here. This means that when rebuilding the package-lock file, the most recent 2.X.X version will be installed. In our case, 2.13.0 is the most recent version and was installed.

This issue is happening now because the package-lock.json file was recently rebuilt as part of EREGCSC-2779.

This pull request changes:

  • Removes caret from CMS Design System version number

Steps to manually verify this change:

  1. Green check marks
  2. Use tab to navigate around the site via the keyboard. Ensure that you don't see any pink focus styles around any elements.

@PhilR8 PhilR8 changed the title [Hotfix] Ensure CMS Design System NPM Package version is 2.5.0 [Hotfix] Ensure CMS Design System npm package version is 2.5.0 Aug 21, 2024
Copy link

✨ See the Django Site in action

@PhilR8 PhilR8 marked this pull request as ready for review August 21, 2024 15:01
@PhilR8 PhilR8 added the Needs Review This PR needs a code review label Aug 21, 2024
Copy link
Contributor

@peggles2 peggles2 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM 👍

@PhilR8 PhilR8 added Approved and removed Needs Review This PR needs a code review labels Aug 21, 2024
@PhilR8 PhilR8 merged commit 3ccd39a into main Aug 21, 2024
20 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants