ar-io / ar-io-node

A scalable and modular gateway built for the permaweb atop the Arweave permanent data storage network.
https://ar.io
GNU Affero General Public License v3.0
97 stars 65 forks source link

chore(yarn): add .yarnrc file to avoid having to pass around --ignore… #181

Closed dtfiedler closed 2 months ago

dtfiedler commented 2 months ago

…-engines everywhere

This is required bc aoconnect encourages the use of npm over yarn.

coderabbitai[bot] commented 2 months ago
Walkthrough ## Walkthrough The primary change involves modifications to the handling of engine compatibility checks in the build process of a Node.js project. The removal of the `--ignore-engines` flag from Yarn commands in both the GitHub Actions workflow and Dockerfile enforces stricter adherence to engine requirements specified in `package.json`. Additionally, a new `.yarnrc` file is introduced to allow for bypassing engine checks, providing flexibility in dependency management. ## Changes | File | Change Summary | |------------------------------------|---------------------------------------------------------------------------------------------------| | `.github/workflows/build-core.yml` | Removed `--ignore-engines` flag from Yarn commands, enforcing engine compatibility checks. | | `.yarnrc` | Added `.yarnrc` file with `ignore-engines true` to allow bypassing engine checks during installs. | | `Dockerfile` | Removed `--ignore-engines` flag from Yarn install commands, enforcing strict engine requirements. |

Recent review details **Configuration used: CodeRabbit UI** **Review profile: CHILL**
Commits Files that changed from the base of the PR and between b989681e4a67dbf1bb81dbd129fe711b4ecc74ed and da46e355a20c9e056799ce995ac10496a925ba42.
Files selected for processing (3) * .github/workflows/build-core.yml (1 hunks) * .yarnrc (1 hunks) * Dockerfile (1 hunks)
Files skipped from review due to trivial changes (1) * .yarnrc
Additional comments not posted (3)
Dockerfile (2)
`11-11`: **Ensure compatibility with engine requirements.** The removal of the `--ignore-engines` flag from the `yarn install` command will enforce engine compatibility checks as specified in `package.json`. This could lead to installation failures if the environment does not meet the specified engine requirements. Verify that the engine requirements are met in all environments where this Dockerfile will be used. --- `14-14`: **Ensure compatibility with engine requirements.** The removal of the `--ignore-engines` flag from the `yarn install --production` command will enforce engine compatibility checks as specified in `package.json`. This could lead to installation failures if the environment does not meet the specified engine requirements. Verify that the engine requirements are met in all environments where this Dockerfile will be used.
.github/workflows/build-core.yml (1)
`30-30`: **Ensure compatibility with engine requirements.** The removal of the `--ignore-engines` flag from the `yarn --immutable --immutable-cache` command will enforce engine compatibility checks as specified in `package.json`. This could lead to build failures if the environment does not meet the specified engine requirements. Verify that the engine requirements are met in all environments where this GitHub Actions workflow will be executed.
--- 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](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `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 generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@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 as 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. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
codecov[bot] commented 2 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 67.43%. Comparing base (b989681) to head (da46e35).

Additional details and impacted files ```diff @@ Coverage Diff @@ ## develop #181 +/- ## ======================================== Coverage 67.43% 67.43% ======================================== Files 29 29 Lines 7151 7151 Branches 383 383 ======================================== Hits 4822 4822 Misses 2328 2328 Partials 1 1 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.