search

getgrit / gritql

GritQL is a query language for searching, linting, and modifying code.
https://docs.grit.io/
MIT License
3.17k stars 83 forks source link

feat: Add workflow upload to cli #493

Closed jsfuentes closed 2 months ago

jsfuentes commented 2 months ago

Add a new CLI Workflow subcommand for uploading

Testing:

Summary by CodeRabbit

coderabbitai[bot] commented 2 months ago
Walkthrough ## Walkthrough The changes introduce a new module for handling workflow uploads in the command-line interface (CLI) of the application. A new command variant, `WorkflowCommands::Upload`, is added to facilitate the uploading of workflows, utilizing a dedicated argument structure. The `run_upload_workflows` function is implemented to manage the upload process, including checking format flags, fetching remote workflow definitions, and applying necessary migrations. Additionally, the visibility of the `fetch_remote_workflow` function is modified to allow access from other modules, enhancing the overall command handling capabilities related to workflows. ## Changes | Files | Change Summary | |---------------------------------------------|-------------------------------------------------------------------------------------------------------------| | `crates/cli/src/commands/mod.rs` | Added `workflows_upload` module, `WorkflowCommands::Upload`, and `run_upload_workflows` function. | | `crates/cli/src/commands/workflows.rs` | Added `Upload` variant to `WorkflowCommands` and imported `WorkflowsUploadArgs`. | | `crates/cli/src/commands/workflows_upload.rs` | Introduced `WorkflowsUploadArgs` struct and implemented `run_upload_workflows` function for uploading workflows. | | `crates/cli/src/workflows.rs` | Changed `fetch_remote_workflow` from private to public, allowing access from other modules. | | `crates/cli/src/commands/apply_migration.rs` | Improved error handling and return type in `run_apply_migration` function. | | `crates/cli/src/commands/apply.rs` | Modified `run_apply` function to include error propagation and maintain asynchronous flow. | | `crates/cli/src/commands/plumbing.rs` | Enhanced error handling in `run_plumbing` function by using `await?` for error propagation. | ## Possibly related PRs - **#332**: Involves cloud workflow connectivity, which may relate to the new workflow upload functionality introduced in the main PR. - **#411**: Enhances the reporting capabilities of workflows by delivering outcomes to the cloud, aligning with the main PR's focus on workflow management and uploads. - **#468**: Addresses exit codes for workflows, relevant to the overall workflow management improvements made in the main PR. - **#489**: Addition of a `--watch` flag for remote workflows connects to the main PR's enhancements in workflow handling and command capabilities. - **#491**: Allows running protected workflows, tying into the main PR's focus on expanding workflow functionalities and management. - **#496**: Introduction of piping workflow output to an emitter enhances logging and output management of workflows, directly relating to the main PR's improvements in workflow handling.
Recent review details **Configuration used: .coderabbit.yaml** **Review profile: CHILL**
Commits Files that changed from the base of the PR and between 757309f7b65c2785f4561a3b6586c0d734d0d6dd and 1ef66587df4d2af99f22a46bfe0fa36b75f07427.
Files selected for processing (1) * crates/cli/src/commands/workflows_upload.rs (1 hunks)
Files skipped from review as they are similar to previous changes (1) * crates/cli/src/commands/workflows_upload.rs
--- 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 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. ### 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.
morgante commented 2 months ago

@jsfuentes Looks like clippy has some concerns, you'll need to run cargo clippy --fix to identify (and auto-fix some issues).