Skip to content
This repository was archived by the owner on Mar 7, 2025. It is now read-only.

DEPRECATION: add deprecation warning to this package #239

Closed

Conversation

DukeFerdinand
Copy link
Contributor

@DukeFerdinand DukeFerdinand commented Mar 6, 2025

Resolves AlaskaAirlines/auro-formkit#394, adding deprecation warning to old form element repositories.

Summary by Sourcery

Chores:

  • Marks the package as deprecated and directs users to migrate to Auro Formkit.

As part of the new formkit release, all old form element repositories are being deprecated.
@DukeFerdinand DukeFerdinand requested a review from a team as a code owner March 6, 2025 18:09
@DukeFerdinand DukeFerdinand self-assigned this Mar 6, 2025
Copy link

sourcery-ai bot commented Mar 6, 2025

Reviewer's Guide by Sourcery

This pull request adds a deprecation warning to the README file of the component, advising users to migrate to the new Auro Formkit.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change Details Files
Added a deprecation warning to the README file.
  • Added a warning message indicating that the component is deprecated and users should migrate to Auro Formkit.
README.md

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!
  • Generate a plan of action for an issue: Comment @sourcery-ai plan on
    an issue to generate a plan of action for it.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link

github-actions bot commented Mar 6, 2025

Surge demo deployment failed! 😭

Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey @DukeFerdinand - I've reviewed your changes - here's some feedback:

Overall Comments:

  • Consider adding a date for when the deprecation goes into effect.
Here's what I looked at during the review
  • 🟡 General issues: 1 issue found
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

# Menu
# Menu (DEPRECATED)

> **WARNING:** This component is deprecated and is no longer supported. Please migrate to the new [Auro Formkit](https://www.npmjs.com/package/@aurodesignsystem/auro-formkit) instead.
Copy link

Choose a reason for hiding this comment

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

issue (typo): Typo in package name and redundant wording in deprecation notice.

The package name in the link should be @aurodesignsystem/auro-formkit. Also, "is deprecated and is no longer supported" is redundant. Suggest simplifying to "This component is deprecated. Please migrate to..."

Suggested change
> **WARNING:** This component is deprecated and is no longer supported. Please migrate to the new [Auro Formkit](https://www.npmjs.com/package/@aurodesignsystem/auro-formkit) instead.
> **WARNING:** This component is deprecated. Please migrate to the new [Auro Formkit](https://www.npmjs.com/package/@aurodesignsystem/auro-formkit).

@DukeFerdinand DukeFerdinand deleted the deprecations/2025_03_05_add_deprecation_warnings branch March 6, 2025 23:03
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

formkit deprecate old form components in respective docs
1 participant