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 #101 #102

Merged
merged 5 commits into from
Nov 23, 2024

Conversation

sun-mota
Copy link
Contributor

@sun-mota sun-mota commented Nov 8, 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: #101

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.

@sun-mota sun-mota self-assigned this Nov 8, 2024
@sun-mota sun-mota requested a review from a team as a code owner November 8, 2024 22:02
@sun-mota sun-mota linked an issue Nov 8, 2024 that may be closed by this pull request
Copy link

sourcery-ai bot commented Nov 8, 2024

Reviewer's Guide by Sourcery

This PR updates the file path references in markdown files to align with the new auro library structure. The changes primarily involve modifying relative path references in various markdown files and updating the auro-library dependency to version 3.0.1.

Class diagram for updated file path references

classDiagram
    class MarkdownFile {
        +String path
    }
    class AuroLibrary {
        +String version
    }
    MarkdownFile --> AuroLibrary : uses
    note for MarkdownFile "Updated path references to align with new library structure"
    note for AuroLibrary "Updated to version 3.0.1"
Loading

File-Level Changes

Change Details Files
Updated markdown file path references to align with new library structure
  • Changed relative paths from './' to '../' in content references
  • Updated paths to use 'docs/partials/' directory structure
  • Modified paths to API examples and documentation files
demo/index.md
README.md
demo/api.md
docs/partials/index.md
docs/partials/api.md
Updated auro-library dependency version
  • Upgraded @aurodesignsystem/auro-library from ^2.8.0 to ^3.0.1
package.json
package-lock.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: 2 issues 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.

README.md Show resolved Hide resolved
demo/index.md Outdated Show resolved Hide resolved
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.

Please add the bundler changes that fixes the unresolved dependencies issue during the build

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.

After installing the repo and running npm run build I receive this error:

> node ./node_modules/@aurodesignsystem/auro-library/scripts/build/generateDocs.mjs

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

@rmenner rmenner requested a review from chrisfalaska November 22, 2024 01:34
@sun-mota sun-mota dismissed chrisfalaska’s stale review November 22, 2024 17:36

npm run build issue is resolved with the latest library version

@jason-capsule42 jason-capsule42 merged commit a218e30 into master Nov 23, 2024
6 checks passed
@jason-capsule42 jason-capsule42 deleted the sunMota/new-build-scripting/101 branch November 23, 2024 18:19
@blackfalcon
Copy link
Member

🎉 This PR is included in version 3.1.6 🎉

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-table: update to latest auro-library version
5 participants