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 #282

Merged
merged 1 commit into from
Mar 7, 2025

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

Adds a deprecation warning to the package, indicating that it is no longer supported and users should migrate to Auro Formkit. Updates the documentation and build process to reflect this change.

Enhancements:

  • Updates the build process to use a custom script for generating documentation for deprecated components.

Documentation:

  • Adds a deprecation warning to the README, advising users to migrate to Auro Formkit.
  • Updates the documentation build process to use a custom script for deprecated components.
  • Updates the documentation template to include a deprecation warning at the top of the page.

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

sourcery-ai bot commented Mar 6, 2025

Reviewer's Guide by Sourcery

This pull request adds a deprecation warning to the auro-dropdown component and updates the documentation build process to accommodate deprecated components. It also updates the CSS link in the README to point to the auro-classic CSS.

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

File-Level Changes

Change Details Files
Adds a deprecation warning to the component's README, advising users to migrate to Auro Formkit.
  • Added a deprecation warning at the top of the README.
  • The warning suggests migrating to the Auro Formkit package.
README.md
docTemplates/README.md
Updates the documentation build process to use a custom script for deprecated components.
  • Replaces the standard documentation build script with deprecatedDocsProcessor.js.
  • Introduces a new script deprecatedDocsProcessor.js to handle documentation generation for deprecated components.
  • Adds a new file docTemplates/README.md to be used as a template for deprecated components.
package.json
docTemplates/README.md
packageScripts/deprecatedDocsProcessor.js
Updates the CSS link in the README to point to the auro-classic CSS.
  • The CSS link was updated to point to auro-classic/CSSCustomProperties.css.
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 more detailed explanation of the deprecation and migration process in the README.
  • It might be helpful to include the date of deprecation to give users a sense of urgency.
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.

// setup
await templateFiller.extractNames();

for (const fileConfig of fileConfigs(config)) {
Copy link

Choose a reason for hiding this comment

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

suggestion: The 'config' parameter is passed to fileConfigs even though fileConfigs does not accept any arguments.

Either update fileConfigs to make use of the provided config or remove the parameter when calling it in processDocFiles.

Suggested change
for (const fileConfig of fileConfigs(config)) {
for (const fileConfig of fileConfigs()) {

@rmenner rmenner merged commit 1145226 into main Mar 7, 2025
6 of 7 checks passed
@rmenner rmenner deleted the deprecations/2025_03_05_add_deprecation_warnings branch March 7, 2025 00:10
@blackfalcon
Copy link
Member

🎉 This PR is included in version 3.2.6 🎉

The release is available on:

Your semantic-release bot 📦🚀

@blackfalcon blackfalcon added the released Completed work has been released label Mar 7, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
released Completed work has been released
Projects
None yet
Development

Successfully merging this pull request may close these issues.

formkit deprecate old form components in respective docs
3 participants