Skip to content

Conversation

@Recxsmacx
Copy link

@Recxsmacx Recxsmacx commented Mar 19, 2025

Related to #3648

Update the Lighthouse CI workflow to use the latest versions of actions and configurations.

  • Lighthouse CI Action: Update the uses directive to treosh/lighthouse-ci-action@v12.
  • Lighthouse Score Report: Update the uses directive to actions/github-script@v7.
  • LightHouse Statistic Comment: Update the uses directive to marocchino/sticky-pull-request-comment@v3.0.
  • Lighthouse Configuration: Add categories:performance with a minimum score of 0.9 to the ci.assert.assertions object. Include uses-http2 in the ci.collect.settings.skipAudits array.

Summary by CodeRabbit

  • New Features

    • Introduced a performance score requirement with a minimum threshold of 85% for enhanced quality audits.
    • Adjusted minimum score requirements for accessibility, best practices, and SEO categories to improve audit flexibility.
    • Updated audit settings to streamline performance reviews by selectively excluding specific checks.
  • Chores

    • Upgraded multiple continuous integration actions to their latest versions for improved audit accuracy and more reliable report generation.

Related to #3648

Update the Lighthouse CI workflow to use the latest versions of actions and configurations.

* **Lighthouse CI Action**: Update the `uses` directive to `treosh/lighthouse-ci-action@v12`.
* **Lighthouse Score Report**: Update the `uses` directive to `actions/github-script@v7`.
* **LightHouse Statistic Comment**: Update the `uses` directive to `marocchino/sticky-pull-request-comment@v3.0`.
* **Lighthouse Configuration**: Add `categories:performance` with a minimum score of 0.9 to the `ci.assert.assertions` object. Include `uses-http2` in the `ci.collect.settings.skipAudits` array.
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Mar 19, 2025

Walkthrough

This pull request updates the versions of several GitHub Actions used in the Lighthouse CI workflow and adjusts the Lighthouse configuration. The GitHub Actions in .github/workflows/lighthouse-ci.yml have been updated to newer versions, while .github/workflows/lighthouserc.json now includes a new performance assertion with a minimum score requirement and excludes the "uses-http2" audit during data collection.

Changes

File(s) Change Summary
.github/workflows/lighthouse-ci.yml Updated action versions: Lighthouse Audit step from commit ref to v12, Score Report step from v6 to v7, and Statistic Comment step to v3.0.
.github/workflows/lighthouserc.json Updated minimum score for accessibility (0.98 to 0.95), best practices (0.92 to 0.90), and SEO (1.00 to 0.95); added performance category (0.85); excluded "uses-http2" audit.

Sequence Diagram(s)

sequenceDiagram
  participant Runner as GitHub Runner
  participant Audit as Lighthouse Audit (v12)
  participant Score as Score Report (v7)
  participant Comment as Stat Comment (v3.0)

  Runner->>Audit: Trigger Lighthouse Audit
  Audit-->>Runner: Return audit results
  Runner->>Score: Process score report
  Score-->>Runner: Return score data
  Runner->>Comment: Update PR comment
  Comment-->>Runner: Confirm comment update
Loading

Suggested labels

ready-to-merge

Suggested reviewers

  • derberg
  • devilkiller-ag
  • akshatnema
  • sambhavgupta0705
  • anshgoyalevil
  • asyncapi-bot-eve
  • Mayaleeeee

Poem

I'm a hopping rabbit on a code-filled spree,
Leaping through workflows so wild and free.
New versions and checks, a garden of change,
Each update a carrot, perfectly arranged.
With whiskers on point and a joyful tune,
I celebrate progress—coding under the moon!
🥕🐰 Happy hops ahead!

Tip

⚡🧪 Multi-step agentic review comment chat (experimental)
  • We're introducing multi-step agentic chat in review comments. This experimental feature enhances review discussions with the CodeRabbit agentic chat by enabling advanced interactions, including the ability to create pull requests directly from comments.
    - To enable this feature, set early_access to true under in the settings.

📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 5a263fe and f2a2e94.

📒 Files selected for processing (1)
  • .github/workflows/lighthouse-ci.yml (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • .github/workflows/lighthouse-ci.yml

🪧 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 generate docstrings to generate docstrings for this 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.

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.

@asyncapi-bot
Copy link
Contributor

asyncapi-bot commented Mar 19, 2025

We require all PRs to follow Conventional Commits specification.
More details 👇🏼

 No release type found in pull request title "fix : draft for checking failing Lighthouse CI". Add a prefix to indicate what kind of release this pull request corresponds to. For reference, see https://www.conventionalcommits.org/

Available types:
 - feat: A new feature
 - fix: A bug fix
 - docs: Documentation only changes
 - style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
 - refactor: A code change that neither fixes a bug nor adds a feature
 - perf: A code change that improves performance
 - test: Adding missing tests or correcting existing tests
 - build: Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)
 - ci: Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs)
 - chore: Other changes that don't modify src or test files
 - revert: Reverts a previous commit

@netlify
Copy link

netlify bot commented Mar 19, 2025

Deploy Preview for asyncapi-website ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit f2a2e94
🔍 Latest deploy log https://app.netlify.com/sites/asyncapi-website/deploys/67da94ac3c3b2f00089dbdab
😎 Deploy Preview https://deploy-preview-3921--asyncapi-website.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@codecov
Copy link

codecov bot commented Mar 19, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (483cd82) to head (f2a2e94).

Additional details and impacted files
@@            Coverage Diff            @@
##            master     #3921   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           21        21           
  Lines          667       667           
  Branches       113       113           
=========================================
  Hits           667       667           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (1)
.github/workflows/lighthouserc.json (1)

7-8: Add SEO and Performance Assertions
The configuration now enforces SEO and performance metrics via new assertions:

  • "categories:seo": ["error", {"minScore": 1.00}]
  • "categories:performance": ["error", {"minScore": 0.90}]

A perfect score of 1.00 for SEO is very strict; please confirm this is intentional given the nature of the SEO audits and the variability of web content. Likewise, the performance threshold of 0.90 should be tested to ensure it aligns with realistic performance criteria for your project.

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 483cd82 and 88eabb0.

📒 Files selected for processing (2)
  • .github/workflows/lighthouse-ci.yml (3 hunks)
  • .github/workflows/lighthouserc.json (2 hunks)
⏰ Context from checks skipped due to timeout of 180000ms (1)
  • GitHub Check: Lighthouse CI
🔇 Additional comments (4)
.github/workflows/lighthouse-ci.yml (3)

51-57: Update Lighthouse Audit Action to v12
The new version (v12) of treosh/lighthouse-ci-action is now in use. Please verify that the new version’s output structure (artifacts, reports, etc.) remains compatible with the downstream steps—especially the configuration file at ./.github/workflows/lighthouserc.json—and does not introduce unexpected side effects.


64-70: Upgrade GitHub Script Action to v7
The action for the Lighthouse Score Report now uses actions/github-script@v7. Ensure that any changes in how the script handles outputs or environment variables are fully compatible with your existing scoring logic. It’s a good idea to test the full workflow end-to-end after this update.

🧰 Tools
🪛 actionlint (1.7.4)

67-67: property "manifest" is not defined in object type {assertionresults: string; links: string; resultspath: string}

(expression)


88-96: Update Sticky PR Comment Action to v3.0
The Lighthouse Statistic Comment step now uses marocchino/sticky-pull-request-comment@v3.0. Please double-check that the token parameter (GH_TOKEN provided here) is intentional and that it conforms with the new version's requirements (many actions expect the token under GITHUB_TOKEN). Verifying the action’s documentation for any input changes would be beneficial.

.github/workflows/lighthouserc.json (1)

19-20: Update Skipped Audits Settings
The skipAudits array now includes "offline-start-url" and "uses-http2". Before proceeding, verify that skipping these audits is acceptable for your overall Lighthouse evaluation, as these audits are sometimes crucial for identifying issues related to offline behavior and HTTP/2 usage.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (1)
.github/workflows/lighthouserc.json (1)

11-21: Updated Skipped Audits in Collection Settings:
The "skipAudits" array now includes "uses-http2". Confirm that excluding this audit does not bypass important checks that could impact the overall analysis of your site’s HTTP/2 performance.

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 88eabb0 and d9fcb1b.

📒 Files selected for processing (2)
  • .github/workflows/lighthouse-ci.yml (2 hunks)
  • .github/workflows/lighthouserc.json (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • .github/workflows/lighthouse-ci.yml
🔇 Additional comments (1)
.github/workflows/lighthouserc.json (1)

2-10: Lighthouse Assertions Updated:
The assertions for accessibility, best-practices, and SEO have been adjusted to use new minimum score thresholds (0.95, 0.90, 0.95 respectively) while also introducing a new performance assertion with a minimum score of 0.85. Please verify that these thresholds are consistent with your quality standards and intended performance objectives.

* Update `uses` directive for `Lighthouse Audit` step to use `treosh/lighthouse-ci-action@v12`
* Update `uses` directive for `Lighthouse Score Report` step to use `actions/github-script@v7`
* Update `uses` directive for `LightHouse Statistic Comment` step to use `marocchino/sticky-pull-request-comment@v3.0`
* Add `artifactName` to `Lighthouse Audit` step with value `lighthouse_results`
* Fix spacing issue in `PR_NUMBER` environment variable
@vishvamsinh28
Copy link
Contributor

#3842 is an bounty issue and it's assigned to @sambhavgupta0705

@Recxsmacx
Copy link
Author

@vishvamsinh28 got it !

@Recxsmacx Recxsmacx closed this Mar 19, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants