ci(documentation-website): lighthouse check with nginx #11
Conversation
Replace nodejs lighthouse test with nginx because of poor performance score. Closes #953
WalkthroughThe changes involve transitioning from a Node.js environment to an Nginx-based setup for running Lighthouse checks on the documentation website. This includes configuring Nginx, modifying the workflow to support these changes, and simplifying the Lighthouse script in the Changes
Poem
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? TipsChatThere are 3 ways to chat with CodeRabbit:
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 as PR comments)
Additionally, you can add CodeRabbit Configration File (
|
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
There was a problem hiding this comment.
Thank you for contributing!
Please make sure the actions pass. Once your pull request has been merged, you will automatically be added to the contributor's list on the website.
If you want to be shouted out on Linkedin, have a look for the shoutout issue of the specific version.
You can also find us on slack at idrinth-api-bench.
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
Review Details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Files selected for processing (2)
- .github/workflows/documentation-website.lighthouse-check.yml (2 hunks)
- nginx.conf (1 hunks)
Additional comments not posted (1)
.github/workflows/documentation-website.lighthouse-check.yml (1)
48-49: Consider verifying the installation of dependencies before running the Lighthouse check.
- Removed unnecessary settings from nginx file such as SSL Settings, Virtual Host Configs, Proxy pass to the Node.js application - Update npm script from lighthouse-check file Closes #953 Co-Authored-By: Björn Büttner <[email protected]>
…/itsmacr8/documentation-website into documentation-website-issue-#953
There was a problem hiding this comment.
Actionable comments posted: 1
Review Details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Files selected for processing (2)
- .github/workflows/documentation-website.lighthouse-check.yml (2 hunks)
- nginx.conf (1 hunks)
Files skipped from review due to trivial changes (1)
- nginx.conf
Additional comments not posted (2)
.github/workflows/documentation-website.lighthouse-check.yml (2)
39-45: CodeRabbit observes that the installation and configuration of Nginx are correctly implemented.
46-49: CodeRabbit queries the execution of Node.js commands under Nginx environment. Clarify the integration between Nginx and Node.js in this context.
|
Let me know if more changes are needed, @Idrinth |
update lighthouse npm script update nginx server configuration
There was a problem hiding this comment.
Actionable comments posted: 2
Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Files selected for processing (2)
- nginx.conf (1 hunks)
- package.json (1 hunks)
Files skipped from review due to trivial changes (1)
- package.json
Additional comments not posted (3)
nginx.conf (3)
2-4: User and worker settings are correctly configured for Nginx.
16-21: HTTP settings are optimized for performance. Disablingserver_tokensenhances security by not sending server version information.
35-42: The root directory is set to serve static files from thedistdirectory, which aligns with the static nature of the documentation website. Cache control headers are appropriately set to prevent caching during development.
| gzip on; | ||
| gzip_disable "msie6"; |
There was a problem hiding this comment.
Gzip compression is enabled, which is beneficial for performance. However, consider updating the gzip_disable directive to reflect more current browsers.
- gzip_disable "msie6";
+ gzip_disable "msie6|msie7";Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
| gzip on; | |
| gzip_disable "msie6"; | |
| gzip on; | |
| gzip_disable "msie6|msie7"; |
|
|
||
| # Events block for handling connections | ||
| events { | ||
| worker_connections 768; |
There was a problem hiding this comment.
Consider enabling multi_accept to handle multiple connections more efficiently.
- # multi_accept on;
+ multi_accept on;Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
| worker_connections 768; | |
| worker_connections 768; | |
| multi_accept on; |
| - 'documentation-website/**.ts' | ||
| - 'documentation-website/**.tsx' | ||
| - 'documentation-website/**.js' | ||
| - 'documentation-website/**.cjs' | ||
| - 'documentation-website/package-lock.json' | ||
| - '.github/workflows/documentation-website.lighthouse-check.yml' | ||
| pull_request: | ||
| branches: | ||
| - the-one | ||
| paths: | ||
| - 'documentation-website/**.ts' | ||
| - 'documentation-website/**.tsx' | ||
| - 'documentation-website/**.js' | ||
| - 'documentation-website/**.cjs' | ||
| - 'documentation-website/package-lock.json' | ||
| - '.github/workflows/documentation-website.lighthouse-check.yml' |
There was a problem hiding this comment.
why is that pointing to documentation-website? That folder exists nowhere
Replace nodejs lighthouse test with nginx because of poor performance score.
Closes #953
The Pull Request is ready
Overview
Review points
Documentation-Website
Notes