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.

Sign up for GitHub

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

Jump to bottom

chore(searchwithin): setup for deprecation #2529

Merged
merged 1 commit into from
Feb 16, 2024
Merged

chore(searchwithin): setup for deprecation #2529

merged 1 commit into from
Feb 16, 2024

Conversation

mdt2
Copy link
Collaborator

@mdt2 mdt2 commented Feb 15, 2024 •
edited by castastrophe
Loading

Description

Preparation for deprecating the searchwithin component

How and where has this been tested?

Please tag yourself on the tests you've marked complete to confirm the tests have been run by someone other than the author.

Validation steps

Check that the steps for flagging a component as deprecated have been completed in this PR:

  • In storybook, searchwithin is in the deprecated section
  • In storybook, searchwithin has a deprecated status (seen in the toolbar)
  • VRTs on this PR do not include searchwithin anymore (result of the parameter that disables chromatic)
  • In the docs site, the component has a deprecation notice at the top

Regression testing

Validate:

  1. The documentation pages for at least two other components are still loading, including:
  • The pages render correctly, are accessible, and are responsive.
  1. If components have been modified, VRTs have been run on this branch:
  • VRTs have been run and looked at.
  • Any VRT changes have been accepted (by reviewer and/or PR author), or there are no changes.

Screenshots

To-do list

  • I have read the contribution guidelines.
  • I have updated relevant storybook stories and templates.
  • I have tested these changes in Windows High Contrast mode.
  • If my change impacts other components, I have tested to make sure they don't break.
  • If my change impacts documentation, I have updated the documentation accordingly.
  • ✨ This pull request is ready to merge. ✨

@mdt2 mdt2 force-pushed the mdt2/css-268-setup-searchwithin-deprecation branch from 7055a43 to 8164ed8 Compare February 15, 2024 21:56
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Feb 15, 2024 •
edited
Loading

🚀 Deployed on https://pr-2529--spectrum-css.netlify.app

@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Feb 15, 2024 •
edited
Loading

File metrics

Summary

Total size: 3.93 MB*

🎉 No changes detected in any packages

* Size determined by adding together the size of the main file for all packages in the library.
* Results are not gzipped or minified.
* An ASCII character in UTF-8 is 8 bits or 1 byte.

castastrophe
castastrophe requested changes Feb 16, 2024
View reviewed changes
Copy link
Collaborator

@castastrophe castastrophe left a comment

Choose a reason for hiding this comment

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

A few very minor updates & this is good to merge. I can do a release once it's in.

components/searchwithin/metadata/searchwithin.yml Outdated Show resolved Hide resolved
components/searchwithin/stories/searchwithin.stories.js Outdated Show resolved Hide resolved
@castastrophe castastrophe added skip_vrt Add to a PR to skip running VRT (but still pass the action) deprecation Flag PRs or issues with this to indicate a component is being deprecated. labels Feb 16, 2024
@mdt2 mdt2 force-pushed the mdt2/css-268-setup-searchwithin-deprecation branch 2 times, most recently from 575ccc8 to e98eb30 Compare February 16, 2024 15:46
castastrophe
castastrophe reviewed Feb 16, 2024
View reviewed changes
components/searchwithin/metadata/searchwithin.yml
description: Override the width of the component where necessary.
sections:
- name: Migration Guide
Copy link
Collaborator

Choose a reason for hiding this comment

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

Should I add deleting migration guides from the docs to the deprecation steps? Or is this something we decide to do ad-hoc?

@castastrophe castastrophe force-pushed the mdt2/css-268-setup-searchwithin-deprecation branch from e98eb30 to 17e806c Compare February 16, 2024 16:19
@castastrophe castastrophe force-pushed the mdt2/css-268-setup-searchwithin-deprecation branch from 17e806c to 95cddca Compare February 16, 2024 16:32
@castastrophe castastrophe enabled auto-merge (squash) February 16, 2024 16:32
@castastrophe castastrophe force-pushed the mdt2/css-268-setup-searchwithin-deprecation branch from 95cddca to 1b648ab Compare February 16, 2024 16:40
@castastrophe castastrophe merged commit ab72d5d into main Feb 16, 2024
10 checks passed
@castastrophe castastrophe deleted the mdt2/css-268-setup-searchwithin-deprecation branch February 16, 2024 16:48
@mdt2 mdt2 mentioned this pull request Feb 16, 2024
Merged
13 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@castastrophe castastrophe castastrophe approved these changes

Assignees
No one assigned
Labels
deprecation Flag PRs or issues with this to indicate a component is being deprecated. ready-to-merge skip_vrt Add to a PR to skip running VRT (but still pass the action)
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@mdt2 @castastrophe