Skip to content

feat: move to npm instad of yarn#80

Merged
xavidop merged 2 commits into
mainfrom
xavier/move-to-npm
Nov 7, 2024
Merged

feat: move to npm instad of yarn#80
xavidop merged 2 commits into
mainfrom
xavier/move-to-npm

Conversation

@xavidop

@xavidop xavidop commented Nov 7, 2024

Copy link
Copy Markdown
Owner

Before you submit a pull request, please make sure you have read and understood the contribution guidelines and the code of conduct.

This pull request is related to:

  • A bug
  • A new feature
  • Documentation
  • Other (please specify)

I have checked the following:

  • I have read and understood the contribution guidelines and the code of conduct;
  • I have added new tests (for bug fixes/features);
  • I have added/updated the documentation (for bug fixes / features).

Description:
Instead of using yarn, use npm

Summary by CodeRabbit

Release Notes

  • New Features

    • Enhanced documentation in the README, including real-time badges and clearer installation instructions.
    • Expanded usage examples for configuring the plugin with GitHub Token.
  • Bug Fixes

    • Updated troubleshooting section to clarify limitations of certain models.
  • Chores

    • Transitioned package management from Yarn to npm across various workflow configurations.
    • Adjusted dependencies in package.json to reflect new management strategy.

@coderabbitai

coderabbitai Bot commented Nov 7, 2024

Copy link
Copy Markdown
Contributor

Caution

Review failed

The pull request is closed.

Walkthrough

The pull request introduces several modifications to GitHub Actions workflows and related files, primarily transitioning from Yarn to npm for dependency management. The caching mechanism in various workflows has been updated to use npm, and the installation steps have been adjusted accordingly. Additionally, the README.md has been enhanced with more detailed documentation, and changes in package.json have restructured certain dependencies. Overall, these changes aim to standardize package management across the project.

Changes

File Change Summary
.github/workflows/codeql.yml Updated caching method from yarn to npm.
.github/workflows/depsreview.yaml Added 0BSD license to allow-licenses parameter in dependency-review job.
.github/workflows/lint.yaml Transitioned from Yarn to npm for caching and installation steps. Changed linting command to npm run lint.
.github/workflows/main.yml Changed caching and installation from Yarn to npm. Updated build command from yarn build to npm run build.
.github/workflows/release.yml Updated caching and installation from Yarn to npm. Adjusted permissions for the release job.
.github/workflows/static.yml Transitioned from Yarn to npm for caching, installation, and documentation build commands.
README.md Enhanced introduction with additional badges, reformatted installation instructions, expanded usage section with detailed examples, and updated troubleshooting section.
package.json Moved @genkit-ai/ai and @genkit-ai/core from dependencies to peerDependencies. Updated script commands to replace yarn with npm.

Possibly related PRs

  • feat: add docs #4: The changes in .github/workflows/static.yml involve a transition from Yarn to npm for dependency management, which aligns with the main PR's modification of the caching mechanism in the CodeQL workflow from yarn to npm.
  • feat: add embedders models #5: The changes in package.json include replacing yarn with npm in script commands, which is directly related to the main PR's focus on changing the caching method from yarn to npm.
  • Replace all text references of Github to GitHub #16: The updates in package.json to correct "Github" to "GitHub" are relevant as they reflect a broader effort to standardize naming conventions, which may include changes to package management practices as seen in the main PR.

🐰 "In the garden of code, we make a shift,
From Yarn to npm, a seamless gift.
With badges bright and docs refined,
Our workflows now more aligned.
Dependencies dance in peer's embrace,
A hop towards clarity in every space!" 🐇✨


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
🪧 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.

@sonarqubecloud

sonarqubecloud Bot commented Nov 7, 2024

Copy link
Copy Markdown

@xavidop
xavidop merged commit 585b533 into main Nov 7, 2024
@xavidop
xavidop deleted the xavier/move-to-npm branch November 7, 2024 17:48
@github-actions

github-actions Bot commented Nov 7, 2024

Copy link
Copy Markdown

🎉 This PR is included in version 1.9.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant