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: deliver workflow outcomes to cloud #411

Merged
merged 4 commits into from
Jul 10, 2024
Merged

Conversation

morgante
Copy link
Contributor

@morgante morgante commented Jul 10, 2024

So we can report the fully summary, it's helpful to report the full outcome back instead of just success.

Greptile Summary

This is an auto-generated summary

  • crates/cli/src/commands/apply_migration.rs: Removed display_workflow_outcome call, handled by emitter.
  • crates/cli/src/result_formatting.rs: Added get_pretty_workflow_message function, workflow_done field, and finish_workflow method.
  • crates/cli/src/workflows.rs: Removed display_workflow_outcome function.
  • crates/marzano_messenger/src/emit.rs: Updated finish_workflow documentation for clarity.

Summary by CodeRabbit

  • Bug Fixes

    • Simplified the migration workflow logic for more consistent outcomes.
  • New Features

    • Enhanced message formatting for clearer workflow success and error messages.
  • Refactor

    • Removed redundant functions to streamline workflow handling.

@morgante morgante changed the title Improve workflow outcomes feat: deliver workflow outcomes to cloud Jul 10, 2024
@morgante morgante marked this pull request as ready for review July 10, 2024 03:15
@morgante morgante requested a review from a team as a code owner July 10, 2024 03:15
Copy link
Contributor

coderabbitai bot commented Jul 10, 2024

Warning

Review failed

The pull request is closed.

Walkthrough

Walkthrough

The changes streamline the way workflow outcomes are handled in the CLI by removing display_workflow_outcome and integrating a new method finish_workflow within FormattedMessager. This unifies the formatting and messaging process for workflow results, offering cleaner code and improved readability. These changes promote a more modular design and improve the tracking of workflow completion status.

Changes

Files Summary
crates/cli/src/commands/apply_migration.rs Removed the call to display_workflow_outcome and replaced it with a simple Ok(()) return.
crates/cli/src/result_formatting.rs Introduced get_pretty_workflow_message, added workflow_done to FormattedMessager, and implemented finish_workflow method.
crates/cli/src/workflows.rs Removed the display_workflow_outcome function.
crates/marzano_messenger/src/emit.rs Updated finish_workflow function to clarify its purpose.

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.

@morgante morgante merged commit f80c503 into main Jul 10, 2024
11 of 12 checks passed
@morgante morgante deleted the improve-workflow-outcomes branch July 10, 2024 03:16
Copy link

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

4 file(s) reviewed, no comment(s)
Edit PR Review Bot Settings

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