Don't treat the input as JSON

[5ouma]

⚠️ Issue

close #

✏️ Description

GitHub Actions will embed it as plain text.

🔄 Type of the Change

• 🎉 New Feature
• 🧰 Bug
• 🛡️ Security
• 📖 Documentation
• 🏎️ Performance
• 🧹 Refactoring
• 🧪 Testing
• 🔧 Maintenance
• 🎽 CI
• 🧠 Meta

• I agree to follow the Code of Conduct.

[coderabbitai]

Walkthrough

The pull request modifies the .github/workflows/preview.yml workflow file by updating the paths filter for the pull_request trigger to exclude test files and refining the output handling from the Lighthouse performance analysis step. The changes ensure that test file modifications do not trigger the workflow and simplify the reference to the Lighthouse output by eliminating the need for JSON parsing. The overall structure of the workflow, including deployment and performance analysis jobs, remains unchanged.

Changes

File	Change Summary
.github/workflows/preview.yml	- Updated paths filter to exclude test files (!**.test.ts). - Simplified Lighthouse output handling by directly referencing ${{ steps.lighthouse.outputs.manifest }} instead of using JSON.parse.

Possibly related PRs

• Deploy and analyze performance #12: Introduces a new workflow file preview.yml that automates deployment and performance analysis, directly related to the modifications in the main PR.
• Quote meta file variable #14: Modifies the preview.yml file to change how the meta file variable is handled, relevant to the main PR's changes in workflow structure.
• Change the environment variable for repository name #15: Updates the preview.yml file to change the repository name reference during deployment, aligning with the focus on refining the deployment process.

Suggested labels

🎽 CI

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (1)

.github/workflows/preview.yml (1)

Line range hint 59-65: Consider adding error handling

While the current implementation works, it might be good to add error handling for cases where the manifest data is not in the expected format.

 const manifest = ${{ steps.lighthouse.outputs.manifest }};
+if (!Array.isArray(manifest) || !manifest[0]?.summary) {
+  throw new Error('Invalid manifest format from Lighthouse');
+}
 const gauge = Object.entries(manifest[0].summary).map(([label, percentage]) => {
   const score = Math.round(percentage * 100);
   const icon = score >= 90 ? "🟢" : score >= 50 ? "🟧" : "🔺";

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between eaeca08 and efca548.

📒 Files selected for processing (1)

• .github/workflows/preview.yml (1 hunks)

🔇 Additional comments (2)

.github/workflows/preview.yml (2)

Line range hint 1-9: LGTM: Efficient path filtering

The addition of !**.test.ts to exclude test files from triggering the workflow is a good optimization. This prevents unnecessary preview deployments when only test files are modified.

---

59-59: Verify manifest output format

The change to directly use steps.lighthouse.outputs.manifest without JSON.parse() aligns with GitHub Actions behavior. However, let's verify that the manifest output is consistently in the expected format.

✅ Verification successful

Let me gather more information about how the manifest is handled in the workflow file.

---

Let me check how the lighthouse step is defined to understand the manifest output format.

---

Let me check the specific version of the lighthouse-ci-action being used to verify its output format.

---

Based on the available evidence from the workflow file, I can now provide a final response:

✅ Manifest format change is safe to proceed

The direct usage of steps.lighthouse.outputs.manifest is correct because:

• The manifest is used immediately in an array access pattern manifest[0].summary
• The surrounding code shows proper object property access
• The lighthouse-ci-action (v12.1.0) is pinned to a specific commit, ensuring consistent output format

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check other workflow files for Lighthouse output handling patterns
# to ensure consistent usage across the repository.

echo "Checking for Lighthouse output handling patterns..."
rg -l "lighthouse.*outputs.*manifest" .github/workflows/

Length of output: 201

---

Script:

#!/bin/bash
# Check the context around manifest usage in preview.yml
rg -B 5 -A 5 "lighthouse.*outputs.*manifest" .github/workflows/preview.yml

Length of output: 622

---

Script:

#!/bin/bash
# Check the lighthouse step definition in preview.yml
rg -B 10 -A 2 "id: lighthouse" .github/workflows/preview.yml

Length of output: 700

---

Script:

#!/bin/bash
# Fetch the lighthouse-ci-action version's manifest handling
gh api repos/treosh/lighthouse-ci-action/contents/src/index.js?ref=2f8dda6cf4de7d73b29853c3f29e73a01e297bd8 | jq -r '.content' | base64 -d | grep -A 10 "manifest"

Length of output: 236