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

Add a linter for migrating from SelectMenu -> SelectPanel #3022

Merged
merged 2 commits into from
Aug 26, 2024

Conversation

camertron
Copy link
Contributor

Authors: Please fill out this form carefully and completely.

Reviewers: By approving this Pull Request you are approving the code change, as well as its deployment and mitigation plans.
Please read this description carefully. If you feel there is anything unclear or missing, please ask for updates.

What are you trying to accomplish?

This PR adds a linter for the old CSS-based SelectMenu component. The linter will suggest using the new SelectPanel component instead.

Integration

No changes necessary in production.

List the issues that this change affects.

Closes https://github.com/github/primer/issues/3876

Risk Assessment

  • Low risk the change is small, highly observable, and easily rolled back.
  • Medium risk changes that are isolated, reduced in scope or could impact few users. The change will not impact library availability.
  • High risk changes are those that could impact customers and SLOs, low or no test coverage, low observability, or slow to rollback.

What approach did you choose and why?

I leveraged our existing CSS linter infrastructure.

Accessibility

  • No new axe scan violation - This change does not introduce any new axe scan violations.

Copy link

changeset-bot bot commented Aug 21, 2024

🦋 Changeset detected

Latest commit: 0744f02

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
@primer/view-components Minor

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@@ -6,7 +6,7 @@ module ERBLint
module Linters
# Counts the number of times a HTML Blankslate is used instead of the component.
class BlankslateComponentMigrationCounter < BaseLinter
MESSAGE = "We are migrating Blankslate to use [Primer::Beta::Blankslate](https://primer.style/view-components/components/beta/blankslate), please try to use that instead of raw HTML."
MESSAGE = "We are migrating Blankslate to use [Primer::Beta::Blankslate](https://primer.style/components/blankslate/rails/beta), please try to use that instead of raw HTML."
Copy link
Contributor Author

Choose a reason for hiding this comment

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

This is not strictly part of this PR, but I noticed the link was wrong so I decided to fix it.

@camertron camertron merged commit 01cbbea into main Aug 26, 2024
37 checks passed
@camertron camertron deleted the select_menu_linter branch August 26, 2024 17:48
@primer primer bot mentioned this pull request Aug 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants