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

fix: update markdown partial pathing to consume new auro lib #72 #73

Merged
merged 3 commits into from
Nov 23, 2024

Conversation

sun-mota
Copy link
Contributor

@sun-mota sun-mota 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: #72

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
  • 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

Bug Fixes:

  • Update markdown partial paths to align with the new auro library structure.

Summary by Sourcery

Bug Fixes:

  • Update markdown partial paths to align with the new auro library structure.

Summary by Sourcery

Bug Fixes:

  • Update markdown partial paths to align with the new auro library structure.

Summary by Sourcery

Update markdown partial paths to align with the new auro library structure and enhance build configuration with updated dependencies and plugins.

Bug Fixes:

  • Update markdown partial paths to align with the new auro library structure.

Enhancements:

  • Add nodeResolve plugin to Rollup configuration for better module resolution.

Build:

  • Update dependency version for @aurodesignsystem/auro-library to ^3.0.1.

Summary by Sourcery

Fix markdown partial paths to accommodate the new auro library structure and enhance the build configuration by updating dependencies and adding the nodeResolve plugin to Rollup.

Bug Fixes:

  • Update markdown partial paths to align with the new auro library structure.

Enhancements:

  • Add nodeResolve plugin to Rollup configuration for better module resolution.

Build:

  • Update dependency version for @aurodesignsystem/auro-library to ^3.0.1.

Summary by Sourcery

Fix markdown partial paths to accommodate the new auro library structure and enhance the build configuration by updating dependencies and adding the nodeResolve plugin to Rollup.

Bug Fixes:

  • Update markdown partial paths to align with the new auro library structure.

Enhancements:

  • Add nodeResolve plugin to Rollup configuration for better module resolution.

Build:

  • Update dependency version for @aurodesignsystem/auro-library to ^3.0.1.

@sun-mota sun-mota self-assigned this Nov 11, 2024
@sun-mota sun-mota requested a review from a team as a code owner November 11, 2024 17:19
Copy link

sourcery-ai bot commented Nov 11, 2024

Reviewer's Guide by Sourcery

This PR updates the markdown partial paths to align with the new auro library structure and enhances the build configuration. The changes primarily involve updating file paths in markdown files and adding the nodeResolve plugin to Rollup for better module resolution.

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

File-Level Changes

Change Details Files
Updated markdown partial file paths to align with new auro library structure
  • Changed relative paths from './../../' to '../' in multiple markdown files
  • Updated paths to point to correct locations in docs/partials directory
  • Modified file source references in AURO-GENERATED-CONTENT blocks
demo/api.md
docs/partials/api.md
demo/index.md
README.md
docs/partials/index.md
Enhanced build configuration for better module resolution
  • Added nodeResolve plugin to Rollup configuration for index and API examples
  • Updated @aurodesignsystem/auro-library dependency to version ^3.0.1
rollup.config.mjs
package.json

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 @sun-mota - 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: 1 issue found

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.

docs/partials/api.md Outdated Show resolved Hide resolved
demo/api.min.js Show resolved Hide resolved
demo/api.min.js Show resolved Hide resolved
demo/api.min.js Show resolved Hide resolved
demo/api.min.js Show resolved Hide resolved
demo/api.min.js Show resolved Hide resolved
demo/api.min.js Show resolved Hide resolved
demo/api.min.js Show resolved Hide resolved
demo/api.min.js Show resolved Hide resolved
demo/api.min.js Show resolved Hide resolved
@jason-capsule42 jason-capsule42 linked an issue Nov 12, 2024 that may be closed by this pull request
Copy link
Member

@jason-capsule42 jason-capsule42 left a comment

Choose a reason for hiding this comment

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

Need to resolve remaining Sourcery review comments - there is a typo in there

Copy link
Contributor

@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.

After running the local run dev, the image under the "Recommended Use and Version Control" appears to be different from the DocSite:

Local version:

Screenshot 2024-11-12 at 1 11 27 PM

DocSite:

Screenshot 2024-11-12 at 1 11 38 PM

@sun-mota
Copy link
Contributor Author

DocSite

Docsite is the one that has a bug :)

@jason-capsule42 jason-capsule42 merged commit a7d9831 into main Nov 23, 2024
6 checks passed
@jason-capsule42 jason-capsule42 deleted the sunMota/new-build-script/72 branch November 23, 2024 18:17
@blackfalcon
Copy link
Member

🎉 This PR is included in version 3.1.1 🎉

The release is available on:

Your semantic-release bot 📦🚀

@blackfalcon blackfalcon added the released Completed work has been released label Nov 23, 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.

auro-banner: update to latest auro-library version
5 participants