framework icon indicating copy to clipboard operation
framework copied to clipboard

feat: [#538] track mockery tool dependencies in go.mod

Open almas-x opened this issue 1 year ago • 6 comments

📑 Description

This update introduces the management of the Mockery tool version within the framework’s go.mod, ensuring consistency across environments. By specifying the version, we avoid discrepancies in generated code caused by version mismatches of Mockery. The command execution now uses go run github.com/vektra/mockery/v2 instead of the previous mockery command. This approach is applicable to Go versions prior to 1.24, as later versions include built-in tool version management.

In Go 1.24 and later, you can execute the Mockery tool with the following command: go get --tool github.com/vektra/mockery/[email protected], and then use go tool mockery to run Mockery.

Mockery is distinguished by a //go:build tools build tag, so its dependencies are not included in the normal build or packaging process.

image

Closes https://github.com/goravel/goravel/issues/538

@coderabbitai summary

✅ Checks

  • [ ] Added test cases for my code

almas-x avatar Feb 20 '25 09:02 almas-x

[!IMPORTANT]

Review skipped

Auto reviews are limited to specific labels.

:label: Labels to auto review (1)
  • 🚀 Review Ready

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.


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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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.

coderabbitai[bot] avatar Feb 20 '25 09:02 coderabbitai[bot]

Codecov Report

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

Project coverage is 67.78%. Comparing base (34c641e) to head (af4d90c). Report is 4 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master     #902      +/-   ##
==========================================
- Coverage   67.83%   67.78%   -0.05%     
==========================================
  Files         154      154              
  Lines       10194    10194              
==========================================
- Hits         6915     6910       -5     
- Misses       2943     2951       +8     
+ Partials      336      333       -3     

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

codecov[bot] avatar Feb 20 '25 09:02 codecov[bot]

I believe this is only necessary for framework developers; adding more dependencies for framework users is unnecessary. Simply adding an instruction about mockery in the contribution guide will also work.

krishankumar01 avatar Feb 20 '25 16:02 krishankumar01

I believe this is only necessary for framework developers; adding more dependencies for framework users is unnecessary. Simply adding an instruction about mockery in the contribution guide will also work.

I mentioned, “Mockery is distinguished by a //go:build tools build tag, so its dependencies are not included in the normal build or packaging process.”

almas-x avatar Feb 20 '25 23:02 almas-x

Contributing code to the framework has become more common, so managing the versions of development tools is essential. First, it prevents developers from needing to install additional tools on their own machines. Second, the Mockery tool updates frequently and often requires adjustments to the production code.

almas-x avatar Feb 20 '25 23:02 almas-x

LGTM, could you update the action file to use the new command? And what's the command in Golang v1.24? Could you update it in the description? We can remove the dependency after Golang v1.23 is not maintained. And please create another PR to update the Goravel document.

Done🔥

almas-x avatar Feb 21 '25 03:02 almas-x