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

fix(world-cli): Ensure the build flag defaults to true #61

Merged
merged 3 commits into from
Apr 22, 2024

Conversation

jerargus
Copy link
Contributor

Closes: WORLD-1063

Overview

Currently, world cardinal start will not rebuild the cardinal container when the code has been modified. Either world cardinal start --build or world cardinal start --build=true needs to be run. This PR makes it so the following 3 commands have the same behavior:

world cardinal start
world cardinal start --build
world cardinal start --build=true

Brief Changelog

Ensure the cfg.Build field is set to true by default.
Refactor the config source file to make the precedent ordering more clear.

Testing and Verifying

To manually test this, checkout this branch and navigate to the world-cli/cmd/world directory. Then run:
go build -o newworld main.go

This creates an executable called newworld. This allows you to compare the behavior of the default world behavior to this branch.

Navigate to the starter-game-template directory.

Run world cardinal start

Docker containers will be built and started. Ctrl+c this process.

Modify the main.go file in the starter game template (e.g. add random newline).

Run world cardinal start again. This should start quickly (because the cardinal container was not rebuilt).

Ctrl+c this process.

Run <path-to-newworld>/newworld cardinal start. This should take a little longer to run, because the cardinal container is actually getting rebuilt this time. You should see some log output signaling that a container is being built.

Ctrl+c this process.

Run <path-to-newworld>/newworld cardinal start again. This should start quickly. While docker received the signal to build cardinal, cardinal hasn't been modified, so it should start quickly.

Copy link

ellipsis-dev bot commented Apr 18, 2024

Your free trial has expired. To continue using Ellipsis, sign up at https://app.ellipsis.dev for $20/developer/month. If you have any questions, reach us at help@ellipsis.dev

Copy link

coderabbitai bot commented Apr 18, 2024

Important

Auto Review Skipped

Auto reviews are disabled on this repository.

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

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 a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @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.

Copy link

codecov bot commented Apr 18, 2024

Codecov Report

Attention: Patch coverage is 84.61538% with 2 lines in your changes are missing coverage. Please review.

Project coverage is 52.45%. Comparing base (4964b7c) to head (4593101).

Files Patch % Lines
common/config/config.go 84.61% 1 Missing and 1 partial ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main      #61      +/-   ##
==========================================
- Coverage   52.89%   52.45%   -0.44%     
==========================================
  Files           9        9              
  Lines         692      692              
==========================================
- Hits          366      363       -3     
- Misses        259      263       +4     
+ Partials       67       66       -1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

common/config/config.go Outdated Show resolved Hide resolved
Copy link
Collaborator

@zulkhair zulkhair left a comment

Choose a reason for hiding this comment

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

lgtm

@jerargus jerargus merged commit 034511d into main Apr 22, 2024
6 checks passed
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