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

temporary fix for README.md to have the correct npm path #127

Merged
merged 1 commit into from
Dec 18, 2024

Conversation

sun-mota
Copy link
Contributor

@sun-mota sun-mota commented Dec 18, 2024

Alaska Airlines Pull Request

Before Submitting this pull request:

  • Link all tickets in this repository related to this PR in the Development section
    note: all pull requests require at least one linked ticket
  • If this PR is Ready For Review, all ticket's linked under Development must have their status changed to Ready For Review as well

By submitting this Pull Request, I confirm that my contribution is made under the terms of the Apache 2.0 license and I have performed a self-review of my own update.

Summary by Sourcery

Fix the npm package path in the README.md and update the build:docs:kit script for direct execution of kitDocProcessor.mjs.

Enhancements:

  • Update the build:docs:kit script to directly call the kitDocProcessor.mjs file.

Documentation:

  • Correct the npm package path in the README.md file to reflect the accurate package location.

@sun-mota sun-mota changed the base branch from main to beta December 18, 2024 19:04
@AlaskaAirlines AlaskaAirlines deleted a comment from sourcery-ai bot Dec 18, 2024
Copy link

sourcery-ai bot commented Dec 18, 2024

Reviewer's Guide by Sourcery

This PR updates the README.md file to correct the npm installation path and badge URLs for the auro-formkit package. It also includes changes to the build configuration in package.json files to streamline the documentation build process.

Class diagram for package.json script changes

classDiagram
    class PackageJson {
        - build:docs:kit: "turbo run --filter=@auro-formkit/build-tools build:docs:kit"
        + build:docs:kit: "node ./packages/build-tools/src/kitDocProcessor.mjs"
    }
    note for PackageJson "Updated the build:docs:kit script to use a direct node command instead of turbo run."
Loading

File-Level Changes

Change Details Files
Update package references and badges in documentation
  • Correct npm installation command from '@auro-formkit/-formkit/-formkit/build-tools' to '@aurodesignsystem/auro-formkit'
  • Update GitHub Actions workflow badge URL
  • Update NPM badge URL with correct package name
  • Update license badge URL with correct package name
README.md
Simplify build documentation process
  • Remove build:docs:kit script from build-tools package.json
  • Move build:docs:kit command directly to root package.json
  • Update build:docs:kit command to use direct node execution instead of turbo
packages/build-tools/package.json
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

@sun-mota sun-mota force-pushed the sunMota/installation-doc/286 branch from a1800c5 to ff44d19 Compare December 18, 2024 19:04
@sun-mota sun-mota marked this pull request as ready for review December 18, 2024 19:26
@sun-mota sun-mota requested a review from a team as a code owner December 18, 2024 19:26
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 - here's some feedback:

Overall Comments:

  • Consider updating the PR title to remove 'temporary' since these appear to be permanent fixes to the package paths and documentation
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.

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.

Looks great!

@sun-mota sun-mota merged commit 19fc981 into beta Dec 18, 2024
4 checks passed
@sun-mota sun-mota deleted the sunMota/installation-doc/286 branch December 18, 2024 19:29
@jason-capsule42
Copy link
Member

🎉 This PR is included in version 1.6.0-beta.5 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants