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

refactor: allow custom version #48

Merged
merged 1 commit into from
Jun 16, 2024
Merged

refactor: allow custom version #48

merged 1 commit into from
Jun 16, 2024

Conversation

kwaa
Copy link
Member

@kwaa kwaa commented Jun 16, 2024

Summary by CodeRabbit

  • New Features

    • Unified the version information across components by introducing a common VERSION constant.
  • Refactor

    • Replaced individual version string retrievals with a centralized VERSION constant for more consistent and maintainable code.

@kwaa kwaa added the enhancement New feature or request label Jun 16, 2024
Copy link

coderabbitai bot commented Jun 16, 2024

Walkthrough

The changes introduce a refactoring across various components of the codebase to consistently use a single VERSION constant sourced from hatsu_utils. This ensures uniformity in how version information is referenced, replacing multiple previous usages of environmental variables for versioning information with the centralized constant.

Changes

File Path Change Summary
crates/api_mastodon/src/entities/instance.rs Updated to use VERSION from hatsu_utils for instance version and description fields.
crates/nodeinfo/src/schema.rs Updated to use the VERSION constant from hatsu_utils instead of env!("CARGO_PKG_VERSION") for the version field in NodeInfoSoftware struct.
crates/utils/src/data.rs Modified import statement to include VERSION and replaced env!("CARGO_PKG_VERSION") with VERSION in the info function.
crates/utils/src/lib.rs Added new version.rs module and exposed the VERSION constant.
crates/utils/src/version.rs Introduced a public constant VERSION that retrieves the version from Cargo metadata.

Poem

In lines of code, where constants roam,
A version unified, now called home.
From hatsu_utils, it shines so bright,
Simplifying the code, making it right.
A single source, no more the strife,
For versions speak with a constant life.
🎉 🐇


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 Configration 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

@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 57dda79 and 6e18822.

Files selected for processing (5)
  • crates/api_mastodon/src/entities/instance.rs (2 hunks)
  • crates/nodeinfo/src/schema.rs (3 hunks)
  • crates/utils/src/data.rs (2 hunks)
  • crates/utils/src/lib.rs (1 hunks)
  • crates/utils/src/version.rs (1 hunks)
Files skipped from review due to trivial changes (3)
  • crates/nodeinfo/src/schema.rs
  • crates/utils/src/data.rs
  • crates/utils/src/version.rs
Additional comments not posted (4)
crates/utils/src/lib.rs (2)

6-6: The addition of the version module enhances modularity by encapsulating version-related functionalities.


10-10: Exporting the VERSION constant publicly is a necessary change to facilitate its use across multiple crates.

crates/api_mastodon/src/entities/instance.rs (2)

2-2: The updated import statement correctly includes the VERSION constant, aligning with the changes in the utility crate.


36-36: Using the VERSION constant from hatsu_utils for both version and description fields in the Instance struct is a good practice, as it centralizes version management and improves maintainability.

Also applies to: 42-42

@kwaa kwaa merged commit 066d188 into main Jun 16, 2024
1 check passed
@kwaa kwaa deleted the refactor/version branch June 16, 2024 07:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant