sun-mota commented 1 week ago

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.

closes #363

Summary:

Please summarize the scope of the changes you have submitted, what the intent of the work is and anything that describes the before/after state of the project.

Type of change:

Please delete options that are not relevant.

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

Checklist:

[x] My update follows the CONTRIBUTING guidelines of this project
[x] 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

Upgrade auro-library to version 3.0.2 and update file paths in documentation and examples to reflect the new directory structure.

Enhancements:

Update file paths in documentation and examples to reflect new directory structure.

Build:

Upgrade auro-library dependency to version 3.0.2.

sourcery-ai[bot] commented 1 week ago

Reviewer's Guide by Sourcery

This PR updates the auro-library dependency to version 3.0.2 and fixes file path references in documentation files. The changes primarily involve updating relative path references in various documentation and demo files to ensure correct content generation.

Class diagram for updated file paths in documentation

classDiagram
    class Documentation {
        +String api.md
        +String index.md
        +String partials/api.md
        +String partials/index.md
        +String partials/description.md
        +String partials/useCases.md
        +String partials/readmeAddlInfo.md
    }
    class Demo {
        +String api.md
        +String index.md
    }
    class ApiExamples {
        +String basic.html
        +String disabled.html
        +String placeholder.html
        +String programmaticValue.html
        +String value.html
        +String maxDate.html
        +String maxNumeric.html
        +String minDate.html
        +String minNumeric.html
        +String pattern.html
        +String borderless.html
        +String readonly.html
        +String activeLabel.html
        +String noValidate.html
        +String required.html
        +String validateOnInput.html
        +String setCustomValidity.html
        +String error.html
        +String password.html
        +String email.html
        +String number.html
        +String maxLength.html
        +String minLength.html
        +String creditCard.html
        +String creditCardIcon.html
        +String monthDayYear.html
        +String monthYear.html
        +String monthFullYear.html
        +String yearMonthDay.html
        +String month.html
        +String year.html
        +String fullYear.html
        +String swapValue.html
        +String custom.html
    }
    Documentation --> Demo : uses
    Documentation --> ApiExamples : references
    Demo --> ApiExamples : includes

File-Level Changes

Change	Details	Files
Update auro-library dependency version	Update @aurodesignsystem/auro-library from ~2.8 to ^3.0.2	`package.json`
Fix documentation file path references	Update relative path references from ./../../ to ./../ Update relative path references from ./../ to ./ Fix AURO-GENERATED-CONTENT file source paths Update README template source reference	`demo/api.md` `docs/partials/api.md` `docs/partials/index.md` `demo/index.md` `README.md`

Assessment against linked issues

Issue	Objective	Addressed	Explanation
#363	Update to version 3.0.1 of auro-library	✅
#363	Update documentation paths from api.md to docs/api.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](https://app.sourcery.ai) 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 - [Contact our support team](mailto:support@sourcery.ai) for questions or feedback. - Visit our [documentation](https://docs.sourcery.ai) for detailed guides and information. - Keep in touch with the Sourcery team by following us on [X/Twitter](https://x.com/SourceryAI), [LinkedIn](https://www.linkedin.com/company/sourcery-ai/) or [GitHub](https://github.com/sourcery-ai).

blackfalcon commented 1 day ago

:tada: This PR is included in version 4.3.0 :tada:

The release is available on:

Your semantic-release bot :package::rocket:

AlaskaAirlines / auro-input

feat: update auro-library to 3.0.2 #363 #364