Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(cli): use proper version for version command #154

Merged

Conversation

cstrnt
Copy link
Member

@cstrnt cstrnt commented Aug 2, 2024

Summary by CodeRabbit

  • New Features

    • Added a version display feature to the CLI tool.
    • Version number now dynamically reflects the actual version from the package manifest.
  • Bug Fixes

    • Improved version management to prevent discrepancies between code and package version.
  • Documentation

    • Updated the changelog to include the details for version 1.2.1.

Copy link

vercel bot commented Aug 2, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
abby-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Aug 2, 2024 11:32pm

Copy link
Contributor

coderabbitai bot commented Aug 2, 2024

Walkthrough

In this update, the @tryabby/cli package has been enhanced to include a version display feature. The version number is now dynamically fetched from package.json, improving accuracy and maintainability. A minor version bump to 1.2.1 reflects these updates, which streamline the CLI tool's version management without altering any public API declarations.

Changes

File Path Change Summary
packages/cli/CHANGELOG.md Added entry for version 1.2.1, noting the new version display feature.
packages/cli/package.json Updated version from 1.2.0 to 1.2.1 to reflect the introduction of improvements.
packages/cli/src/index.ts Changed version setting from hardcoded "0.0.1" to dynamic fetching from package.json. Added import for packageJson.

Poem

🐇 In the land of code where bunnies hop,
A version update made our spirits pop!
From "zero point one" to a new delight,
Now it’s dynamic, oh what a sight!
With every command, our joy will soar,
Thanks to the changes, we’ll code even more! 🌟


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

Copy link
Member Author

cstrnt commented Aug 2, 2024

This stack of pull requests is managed by Graphite. Learn more about stacking.

Join @cstrnt and the rest of your teammates on Graphite Graphite

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

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 342c786 and ece32d1.

Files selected for processing (3)
  • packages/cli/CHANGELOG.md (1 hunks)
  • packages/cli/package.json (1 hunks)
  • packages/cli/src/index.ts (1 hunks)
Files skipped from review due to trivial changes (2)
  • packages/cli/CHANGELOG.md
  • packages/cli/package.json
Additional comments not posted (2)
packages/cli/src/index.ts (2)

18-18: LGTM: Import statement for packageJson.

The import statement is correctly fetching the package.json file from the parent directory.


24-24: LGTM: Dynamic version fetching.

The program.version(packageJson.version) change ensures that the CLI version is always in sync with package.json, improving maintainability.

However, ensure that packageJson.version is correctly defined in package.json.

@cstrnt cstrnt merged commit a52ff57 into main Aug 3, 2024
5 checks passed
@cstrnt cstrnt deleted the tim08-03-feat_cli_use_proper_version_for_version_command branch August 3, 2024 00:40
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.

1 participant