RC #315

[rmenner]

Alaska Airlines Pull Request

Release candidate pull request. See issue #315 for details.

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 CLI documentation and align CI workflows with Node 22+/npm 12 requirements for trusted publishing.

Build:

• Regenerate package-lock.json to reflect updated dependency or tooling changes.

CI:

• Update GitHub Actions workflows to use Node 22+/24 and npm 12 with trusted publishing-compatible configuration, including registry setup and credential handling.

Documentation:

• Rewrite README to describe Auro CLI capabilities, installation, and full command reference for development, repo maintenance, and release workflows.

[sourcery-ai]

Reviewer's Guide

Refreshes README to provide full CLI command reference and updates CI workflows to use Node 22/24 with npm 12 for Trusted Publishing compatibility, along with corresponding lockfile changes.

Flow diagram for updated release pipeline CLI commands

flowchart TD
  A[GitHub_Actions_workflow] --> B[auro_rc-workflow]
  B --> C[RC_branch_and_PR_created]

  A --> D[auro_pr-release]
  D --> E[package_json_preview_version_set]

  A --> F[auro_check-commits]
  F --> G[PR_labels_and_release_notes]

Loading

File-Level Changes

Change	Details	Files
Revamp README with installation instructions and detailed command reference for the Auro CLI.	Replace brief CLI description with badges and a higher-level explanation of the tool’s purpose. Add explicit npm install and npx usage examples. Introduce a commands overview section grouping dev, repo maintenance, and release pipeline commands in tables. Document full option lists and behavior for dev, build, docs, test, sync, migrate, agent, ado, rc-workflow, pr-release, and check-commits commands.	README.md
Update GitHub Actions CI to target newer Node.js and npm versions required for npm Trusted Publishing and adjust checkout/setup options.	Expand the test-and-release job matrix to test on Node 20, 22, and 24 instead of a pinned 22.22.1. Switch release jobs to use Node 22 with a comment noting the Trusted Publishing minimum version and configure the npm registry URL. Pin global npm upgrade to npm@12 with a comment explaining the Trusted Publishing requirement. Disable persist-credentials on the release job checkout to support OIDC-based publishing.	.github/workflows/test-and-release.yml .github/workflows/pr-release.yml
Regenerate package-lock.json to reflect dependency or toolchain changes consistent with the updated environment.	Update the lockfile metadata and dependency tree to align with the current package.json and new Node/npm versions.	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. You can also reply to a
  review comment with @sourcery-ai issue to create an issue from it.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a title at any time. You can also comment
  @sourcery-ai title on the pull request to (re-)generate the 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 exactly where you
  want it. You can also comment @sourcery-ai summary on the pull request to
  (re-)generate the summary at any time.
• Generate reviewer's guide: Comment @sourcery-ai guide on the pull
  request to (re-)generate the reviewer's guide at any time.
• Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
  pull request to resolve all Sourcery comments. Useful if you've already
  addressed all the comments and don't want to see them anymore.
• Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
  request to dismiss all existing Sourcery reviews. Especially useful if you
  want to start fresh with a new review - don't forget to comment
  @sourcery-ai review to trigger a new review!

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

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[sourcery-ai]

Hey - I've left some high level feedback:

Fixed security issues:

• brace-expansion (link)

• fast-uri (link)

• form-data (link)

• immutable (link)

• minimatch (link)

• postcss (link)

• svgo (link)

• ws (link)

• In the GitHub Actions workflows, consider upgrading npm before running npm clean-install so that dependency installation also benefits from the trusted-publishing–compatible npm version instead of using two different npm versions in a single job.

• The auro ado CLI option in the README (-g, --gh-issue <issue>) could clarify the expected format (issue number vs URL vs owner/repo#number) to prevent ambiguity for consumers.

Prompt for AI Agents

Please address the comments from this code review:

## Overall Comments
- In the GitHub Actions workflows, consider upgrading npm before running `npm clean-install` so that dependency installation also benefits from the trusted-publishing–compatible npm version instead of using two different npm versions in a single job.
- The `auro ado` CLI option in the README (`-g, --gh-issue <issue>`) could clarify the expected format (issue number vs URL vs `owner/repo#number`) to prevent ambiguity for consumers.

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}