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

feat: update auro-library to 3.0.1 #203

Merged
merged 2 commits into from
Nov 14, 2024
Merged

Conversation

DukeFerdinand
Copy link
Contributor

@DukeFerdinand DukeFerdinand commented Nov 11, 2024

Alaska Airlines Pull Request

Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.

Resolves: #202

Summary:

This updates to the latest auro-library version and ensures the documentation paths are updated in index.md and api.md to match!

Type of change:

Please delete options that are not relevant.

  • New capability
  • Revision of an existing capability
  • Infrastructure change (automation, etc.)
  • Other (please elaborate)

Checklist:

  • My update follows the CONTRIBUTING guidelines of this project
  • I have performed a self-review of my own update

By submitting this Pull Request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

Pull Requests will be evaluated by their quality of update and whether it is consistent with the goals and values of this project. Any submission is to be considered a conversation between the submitter and the maintainers of this project and may require changes to your submission.

Thank you for your submission!

-- Auro Design System Team

Summary by Sourcery

Update auro-library to version 3.0.1 and adjust documentation paths to align with the new directory structure.

New Features:

  • Update auro-library to version 3.0.1.

Documentation:

  • Update documentation paths in index.md and api.md to reflect new directory structure.

@DukeFerdinand DukeFerdinand requested a review from a team as a code owner November 11, 2024 06:11
Copy link

sourcery-ai bot commented Nov 11, 2024

Reviewer's Guide by Sourcery

This PR updates the auro-library dependency to version 3.0.1 and updates documentation file paths to match the new structure. The changes primarily involve updating file paths in markdown files to correctly reference documentation and example files from their new locations.

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

File-Level Changes

Change Details Files
Updated auro-library dependency version
  • Upgraded auro-library from ~2.8.0 to ^3.0.1
package.json
package-lock.json
Updated documentation file paths
  • Changed paths from ./../api.md to ./../docs/api.md
  • Updated paths from ./../../apiExamples/ to ./../apiExamples/
  • Updated paths for description.md and useCases.md to reference docs/partials directory
  • Updated README.md template source reference
demo/api.md
demo/index.md
docs/partials/api.md
docs/partials/index.md
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.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a 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. You can also use
    this command to specify where the summary should be inserted.

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

@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 and they look great!

Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 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.

@chrisfalaska chrisfalaska linked an issue Nov 12, 2024 that may be closed by this pull request
Copy link

@chrisfalaska chrisfalaska left a comment

Choose a reason for hiding this comment

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

While running the build command, I experienced this error:

> @aurodesignsystem/auro-combobox@2.1.4 build:docs
> node ./node_modules/@aurodesignsystem/auro-library/scripts/build/generateDocs.mjs

Retrieving latest "/Users/Chris.Friedberg@alaskaair.com/Dev/auro-combobox/docTemplates/README.md" file...
Error writing file: /Users/Chris.Friedberg@alaskaair.com/Dev/auro-combobox/docTemplates/README.md, ENOENT: no such file or directory, open '/Users/Chris.Friedberg@alaskaair.com/Dev/auro-combobox/docTemplates/README.md'
Error copying file: /Users/Chris.Friedberg@alaskaair.com/Dev/auro-combobox/docTemplates/README.md, ENOENT: no such file or directory, copyfile '/Users/Chris.Friedberg@alaskaair.com/Dev/auro-combobox/docTemplates/README.md' -> '/Users/Chris.Friedberg@alaskaair.com/Dev/auro-combobox/README.md'
Error processing README.md: Error copying "/Users/Chris.Friedberg@alaskaair.com/Dev/auro-combobox/docTemplates/README.md" file to output /Users/Chris.Friedberg@alaskaair.com/Dev/auro-combobox/README.md

Copy link

@chrisfalaska chrisfalaska left a comment

Choose a reason for hiding this comment

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

Tested locally 🚀

@sun-mota sun-mota merged commit f34709b into main Nov 14, 2024
6 checks passed
@sun-mota sun-mota deleted the dhook/update-auro-library branch November 14, 2024 20:18
@blackfalcon
Copy link
Member

🎉 This PR is included in version 2.2.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

@blackfalcon blackfalcon added the released Completed work has been released label Nov 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
released Completed work has been released
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update auro library
4 participants