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

Prepare 7.0 breaking changes #298

Merged
merged 9 commits into from
Apr 3, 2023
Merged

Prepare 7.0 breaking changes #298

merged 9 commits into from
Apr 3, 2023

Conversation

aduth
Copy link
Member

@aduth aduth commented Feb 18, 2022

This is a staging area for breaking changes we'd like to implement in a future major version release.

Currently, it includes:

Breaking Changes

  • Sass artifacts now require Dart Sass. The Ruby Sass and LibSass (C) compilers are no longer supported.
  • To improve performance of the default CSS bundle, responsive utility breakpoints other than tablet: have been disabled by default. Previously, mobile-lg: and desktop: utilities were also enabled. You can restore the original settings by overriding the $theme-utility-breakpoints Sass variable.
  • Image URLs in stylesheets are no longer processed by asset-path-if-exists. For Rails integrations, consider using the $theme-image-path Sass variable in combination with Sprockets resolve_assets_in_css_urls option.
  • The deprecated $image-path Sass variable setting has been removed. Use $theme-image-path instead.
  • The deprecated alerts/success-badge.svg image has been removed. Use alerts/success.svg instead.

@aduth
Copy link
Member Author

aduth commented Feb 18, 2022

Other ideas:

  • Remove components for improved upstream compatibility with USWDS and reduced global style pollution:
    • Badges
      • Could be implemented specific to IdP
      • Unsure of long-term desire to keep
    • Cards
    • Spinner
      • It's a bad practice for us to be recommending
      • Could be implemented specific to IdP
      • Consider consolidating / reconciling with IdP "Spinner Button"
    • Code formatting
      • Pollutes global styles
      • Not applicable to every project
  • Remove project-specific or documentation-specific images

@aduth
Copy link
Member Author

aduth commented Mar 25, 2022

It probably makes sense to release the next major version in tandem with USWDS v3, which is slated for release next month.

@aduth aduth force-pushed the aduth-7-0-breaking-changes branch from 8ff1c7c to 16c0c78 Compare August 17, 2022 12:51
@aduth aduth marked this pull request as ready for review August 17, 2022 13:51
@aduth
Copy link
Member Author

aduth commented Aug 17, 2022

Other ideas:

I still like many of these ideas, but we can save them for a future major release.

@aduth
Copy link
Member Author

aduth commented Mar 31, 2023

@zachmargolis I think I'd like to include these changes in the upcoming release. Could I tap you for a review?

@aduth aduth requested a review from zachmargolis March 31, 2023 19:32
Copy link
Contributor

@zachmargolis zachmargolis left a comment

Choose a reason for hiding this comment

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

LGTM

CHANGELOG.md Outdated Show resolved Hide resolved
@aduth aduth force-pushed the aduth-7-0-breaking-changes branch from 2d0e940 to 9a579f0 Compare April 3, 2023 12:17
@aduth
Copy link
Member Author

aduth commented Apr 3, 2023

Visual regression failure is from the removal of the "Limiting Alert Width" documentation section, which is an expected breaking change.

@aduth aduth merged commit f88f557 into main Apr 3, 2023
@aduth aduth deleted the aduth-7-0-breaking-changes branch April 3, 2023 12:26
aduth added a commit that referenced this pull request Apr 3, 2023
Fixes issue where documentation pages with sidebar appear incorrectly stacked. Consistent with changes proposed in #298 (specifically 24ed561), standardize on the "tablet" breakpoint.
aduth added a commit that referenced this pull request Apr 3, 2023
Fixes issue where documentation pages with sidebar appear incorrectly stacked. Consistent with changes proposed in #298 (specifically 24ed561), standardize on the "tablet" breakpoint.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants