Conversation
- adjust workflows to publish without token
Reviewer's GuideThis PR refactors the documentation build pipeline by separating API generation and Markdown compilation, adds a development server command, updates the CLI interface, enhances filter logic in the docs generator, bumps npm in CI workflows, and adapts the analyze script to use the new API task. Sequence diagram for new docs CLI command flowsequenceDiagram
participant User as actor User
participant CLI as "docsCommand"
participant Docs as "Docs"
participant API as "api()"
participant Serve as "serve()"
User->>CLI: Run docs command with options
CLI->>Docs: cem() (if --cem)
CLI->>API: api() (if --api)
CLI->>Docs: docs()
CLI->>Serve: serve(options) (if --serve)
Class diagram for updated Docs generator and documentation tasksclassDiagram
class Docs {
+static manifest
+static getElements() CustomElementDeclaration[]
+static isWcaModule(module)
+static generate()
}
Docs : +static getElements() CustomElementDeclaration[]
Docs : getElements() now uses wcaModules filter logic
Docs : generate() used by api task
class APITask {
+async api()
}
class DocsTask {
+async docs()
}
class ServeTask {
+async serve(options)
}
Docs <.. APITask : uses
Docs <.. DocsTask : uses
ServeTask <.. DocsTask : can be triggered after docs
Flow diagram for documentation build pipeline after refactorflowchart TD
A["cem() - Generate Custom Elements Manifest"]
B["api() - Generate API md file"]
C["docs() - Compile documentation"]
D["serve() - Start development server"]
A --> B --> C --> D
A -.-> C
B -.-> D
C -.-> D
%% Dashed arrows indicate optional/conditional steps based on CLI options
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
There was a problem hiding this comment.
Hey there - I've reviewed your changes - here's some feedback:
- The
apianddocsflags on the singledocscommand can be confusing—consider splitting them into distinct commands or more descriptive flags for clarity. - Rather than reassigning
docsCommandvia alet, chain your.command().option().action()calls directly to simplify the CLI setup. - In
Docs.getElements, you filterwcaModulesthen check them again in the reducer—merging those conditions into a single pass would improve readability.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- The `api` and `docs` flags on the single `docs` command can be confusing—consider splitting them into distinct commands or more descriptive flags for clarity.
- Rather than reassigning `docsCommand` via a `let`, chain your `.command().option().action()` calls directly to simplify the CLI setup.
- In `Docs.getElements`, you filter `wcaModules` then check them again in the reducer—merging those conditions into a single pass would improve readability.
## Individual Comments
### Comment 1
<location> `src/scripts/docs/index.ts:50-52` </location>
<code_context>
}
}
+
+export async function serve(options = {}) {
+ await startDevelopmentServer(options);
+}
</code_context>
<issue_to_address>
**suggestion:** The serve function does not handle errors from startDevelopmentServer.
Add error handling to serve to log errors and provide spinner feedback, ensuring consistency with other exported functions.
```suggestion
import ora from "ora";
export async function serve(options = {}) {
const serveSpinner = ora("Starting development server...").start();
try {
await startDevelopmentServer(options);
serveSpinner.succeed("Development server started successfully!");
} catch (error) {
const errorMessage = error instanceof Error ? error.message : String(error);
serveSpinner.fail("Failed to start development server: " + errorMessage);
console.error(error);
throw error;
}
}
```
</issue_to_address>
### Comment 2
<location> `.github/workflows/pr-release.yml:38` </location>
<code_context>
run: npm run auro-internal -- pr-release -p ${{ github.event.pull_request.number }}
- name: Publish to NPM
- run: npm publish --registry=https://registry.npmjs.org
+ run: npm publish --registry=https://registry.npmjs.org --tag=latest
env:
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
</code_context>
<issue_to_address>
**question (bug_risk):** Adding --tag=latest to npm publish may overwrite the latest tag unexpectedly.
Using --tag=latest for PR releases may unintentionally mark unstable builds as the latest stable version. Use a distinct tag for PR or pre-release builds to avoid confusion.
</issue_to_address>Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
DukeFerdinand
approved these changes
Nov 13, 2025
Member
|
🎉 This PR is included in version 3.3.0 🎉 The release is available on: Your semantic-release bot 📦🚀 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Alaska Airlines Pull Request
Checklist:
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
Introduce separate API and documentation build commands, a development server, and refine documentation generation and CI workflows
New Features:
Enhancements:
CI: