Skip to content

fix: command should fail in case deployment failed #919

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

Merged
merged 1 commit into from
Apr 17, 2025
Merged

Conversation

janb87
Copy link
Contributor

@janb87 janb87 commented Apr 16, 2025

Summary by Sourcery

Bug Fixes:

  • Fix the command completion logic to return false when a deployment fails, which allows the calling command to detect and handle deployment failures

Copy link
Contributor

sourcery-ai bot commented Apr 16, 2025

Reviewer's Guide by Sourcery

This pull request modifies the waitForCompletion function to ensure that the CLI command fails when a deployment fails. The change involves returning false when a deployment fails, which will cause the command to exit with an error code.

Sequence diagram for deployment failure handling

sequenceDiagram
  participant CLI
  participant waitForCompletion
  CLI->>waitForCompletion: Await deployment completion
  waitForCompletion->>waitForCompletion: Check deployment status
  alt Deployment Failed
    waitForCompletion-->>CLI: Return false
    CLI->>CLI: Exit with error code
  else Deployment Succeeded
    waitForCompletion-->>CLI: Return true
    CLI->>CLI: Continue execution
  end
Loading

File-Level Changes

Change Details Files
Ensure the CLI command fails when a deployment fails.
  • Modified the waitForCompletion function to return false when a deployment fails.
  • This change ensures that the CLI command exits with an error code when a deployment fails.
sdk/cli/src/commands/platform/utils/wait-for-completion.ts

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!
  • Generate a plan of action for an issue: Comment @sourcery-ai plan on
    an issue to generate a plan of action for it.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@github-actions github-actions bot added the fix label Apr 16, 2025
Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey @janb87 - I've reviewed your changes - here's some feedback:

Overall Comments:

  • Consider adding a log message indicating the reason for the deployment failure to aid in debugging.
Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟡 Review instructions: 1 issue found
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

Copy link

📦 Packages

Package NPM Docker
SDK Cli @settlemint/[email protected]
SDK The Graph @settlemint/[email protected]
SDK Portal @settlemint/[email protected]
SDK Hasura @settlemint/[email protected]
SDK JS @settlemint/[email protected]
SDK Utils @settlemint/[email protected]
SDK Next @settlemint/[email protected]
SDK Minio @settlemint/[email protected]
SDK IPFS @settlemint/[email protected]
SDK Blockscout @settlemint/[email protected]
SDK MCP @settlemint/[email protected]

@janb87 janb87 enabled auto-merge (squash) April 16, 2025 07:27
@janb87 janb87 merged commit c0c9792 into main Apr 17, 2025
5 checks passed
@janb87 janb87 deleted the jan/command-failed branch April 17, 2025 07:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants