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: Updated CLI to permit force deploy #95

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

ezavada
Copy link
Contributor

@ezavada ezavada commented Jan 31, 2025

Closes: PLAT-88

world forge deployment deploy now supports a flag --force. When used, any currently running deployment will be cancelled and the new one started. Without that flag, the deploy will fail if there is a currently running deployment that is less than an hour old

Summary by CodeRabbit

  • New Features

    • Added a --force flag to the deployment command.
    • Enhanced deployment functionality to allow forcing a deployment when another is in progress.
  • Improvements

    • Updated deployment logic to utilize constants for deployment types, improving clarity and maintainability.

Copy link

graphite-app bot commented Jan 31, 2025

How to use the Graphite Merge Queue

Add the label graphite/merge to this PR to add it to the merge queue.

You must have a Graphite account in order to use the merge queue. Sign up using this link.

An organization admin has enabled the Graphite Merge Queue in this repository.

Please do not merge from GitHub as this will restart CI on PRs being processed by the merge queue.

Copy link

coderabbitai bot commented Jan 31, 2025

Walkthrough

The pull request introduces a new --force flag to the World CLI deployment command, enabling users to force a deployment even if another deployment is currently in progress. The changes modify two files in the cmd/world/forge/ directory: forge.go and deployment.go. The implementation adds a flag to the deployCmd and updates the deployment logic to utilize defined constants for deployment types, enhancing code clarity and maintainability.

Changes

File Change Summary
cmd/world/forge/forge.go Added --force flag to deployCmd with default value false and updated RunE function to handle force deployment.
cmd/world/forge/deployment.go Added constants for deployment types (DeploymentTypeDeploy, DeploymentTypeDestroy, DeploymentTypeReset) and updated deployment function to use these constants instead of string literals.

Assessment against linked issues

Objective Addressed Explanation
Add World CLI option to force deploy [PLAT-88]

Possibly related PRs

  • feat: Implemented deployment status check #88: The changes in the main PR are related to the modifications in the deployment function in the cmd/world/forge/deployment.go file, as both PRs involve updates to this function, albeit for different purposes.
  • feat: add deployment reset command #89: The changes in the main PR are related to the modifications made to the deployment function in the cmd/world/forge/deployment.go file, as both PRs involve updates to the same function and its usage in the command structure.

Suggested reviewers

  • zulkhair

Tip

🌐 Web search-backed reviews and chat
  • We have enabled web search-based reviews and chat for all users. This feature allows CodeRabbit to access the latest documentation and information on the web.
  • You can disable this feature by setting web_search: false in the knowledge_base settings.
  • Please share any feedback in the Discord discussion.

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 65e3398 and 5cad26a.

📒 Files selected for processing (1)
  • cmd/world/forge/deployment.go (5 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • cmd/world/forge/deployment.go
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: Analyze (go)

🪧 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.

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

🧹 Nitpick comments (1)
cmd/world/forge/forge.go (1)

295-296: Consider enhancing the flag description.

The current description is good but could be more explicit about the impact of force deployment.

-	deployCmd.Flags().Bool("force", false,
-		"Start the deploy even if one is currently running. Cancels current running deploy.")
+	deployCmd.Flags().Bool("force", false,
+		"Force start a new deployment even if one is currently running. WARNING: This will cancel any currently running deployment.")
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between e3e7ed3 and 65e3398.

📒 Files selected for processing (2)
  • cmd/world/forge/deployment.go (1 hunks)
  • cmd/world/forge/forge.go (2 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (4)
  • GitHub Check: Unit & Coverage
  • GitHub Check: Unit & Coverage
  • GitHub Check: Go
  • GitHub Check: Analyze (go)
🔇 Additional comments (2)
cmd/world/forge/deployment.go (1)

59-61: LGTM!

The implementation correctly handles force deployment by modifying the URL parameter. The approach is clean and maintains backward compatibility with existing deployment types.

cmd/world/forge/forge.go (1)

220-225: LGTM!

The implementation correctly handles the force flag and sets the appropriate deployment type. The code is clean and maintains the existing deployment flow.

@ezavada ezavada requested a review from zulkhair January 31, 2025 21:50
- replaced hardcoded strings for Deployment Types with constants
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.

2 participants