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: check git configuration before exec world create #74

Open
wants to merge 1 commit into
base: daim/change_docker_compose_using_docker_api_sdk
Choose a base branch
from

Conversation

zulkhair
Copy link
Collaborator

@zulkhair zulkhair commented Aug 27, 2024

Closes: WORLD-1177

Overview

When user trying to exec world create but git configuration .gitconfig for username and password is not configured it will be returned error, but the gameshard dir is already created.

The issue is because on the last step of world create it will exec git commit, and it will need username and email to be configured in .gitconfig

Solutions
Before executing world create, world cli will check the git configuration is configured or not. if it's not, world cli will tell the command how to configure the git config.

Brief Changelog

  • Create func for checking git configuration
  • Call the function at the first execution of world create command

Testing and Verifying

  • Added unit test for checkGitConfig func

Copy link

graphite-app bot commented Aug 27, 2024

Your org has enabled the Graphite merge queue for merging into main

Add the label “graphite/merge” to the PR and Graphite will automatically add it to the merge queue when it’s ready to merge.

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

Copy link

coderabbitai bot commented Aug 27, 2024

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

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.


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 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
Collaborator Author

zulkhair commented Aug 27, 2024

Warning

This pull request is not mergeable via GitHub because a downstack PR is open. Once all requirements are satisfied, merge this PR as a stack on Graphite.
Learn more

This stack of pull requests is managed by Graphite. Learn more about stacking.

Join @zulkhair and the rest of your teammates on Graphite Graphite

@zulkhair zulkhair mentioned this pull request Aug 27, 2024
Copy link

codecov bot commented Aug 27, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Please upload report for BASE (daim/change_docker_compose_using_docker_api_sdk@6eee015). Learn more about missing BASE report.

Additional details and impacted files
@@                                Coverage Diff                                 @@
##             daim/change_docker_compose_using_docker_api_sdk      #74   +/-   ##
==================================================================================
  Coverage                                                   ?   47.58%           
==================================================================================
  Files                                                      ?       52           
  Lines                                                      ?     2360           
  Branches                                                   ?        0           
==================================================================================
  Hits                                                       ?     1123           
  Misses                                                     ?     1039           
  Partials                                                   ?      198           

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

@zulkhair zulkhair force-pushed the daim/check_git_configuration branch from d518417 to e00d350 Compare August 27, 2024 08:26
@zulkhair zulkhair marked this pull request as ready for review August 27, 2024 08:27
@zulkhair zulkhair changed the title check git configuration before exec world create fix: check git configuration before exec world create Aug 27, 2024
Copy link
Member

@smsunarto smsunarto left a comment

Choose a reason for hiding this comment

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

The cleaner fix here is to do the git commit with an author flag like this such that the problem doesn't exist in the first place

git commit --author="World CLI [email protected]" -m "whatever"

Copy link
Collaborator Author

The cleaner fix here is to do the git commit with an author flag like this such that the problem doesn't exist in the first place

git commit --author="World CLI [email protected]" -m "whatever"

oh man, this is a very good approach. I didn't think about that. 👍🏻

@zulkhair zulkhair force-pushed the daim/check_git_configuration branch from e00d350 to b4a4011 Compare August 27, 2024 18:54
Copy link
Collaborator Author

@smsunarto i think the approach using --author is not working. i tested it on fresh installed ubuntu and windows and got this error, even i try to run the git command manually. still need to set user.email and user.name,

image.png

i will bring back the checkGitConfig func.

@zulkhair zulkhair force-pushed the daim/check_git_configuration branch from b4a4011 to edf8145 Compare August 28, 2024 07:07
@zulkhair
Copy link
Collaborator Author

zulkhair commented Aug 28, 2024

@smsunarto i think the approach using --author is not working. i tested it on fresh installed ubuntu and windows and got this error, even i try to run the git command manually. still need to set user.email and user.name,

image.png

i will bring back the checkGitConfig func.

Oh apparently it just lacks env. we can use :

GIT_COMMITTER_NAME="World CLI" GIT_COMMITTER_EMAIL="[email protected]" git commit --author="World CLI <[email protected]>" -m "Initial commit from World CLI"

i tried it and works perfectly.

@zulkhair zulkhair force-pushed the daim/check_git_configuration branch from edf8145 to 55608ae Compare August 28, 2024 07:23
Copy link

graphite-app bot commented Sep 23, 2024

Merge activity

Closes: WORLD-1177

## Overview

When user trying to exec `world create` but git configuration `.gitconfig` for username and password is not configured it will be returned error, but the gameshard dir is already created.

The issue is because on the last step of `world create` it will exec git commit, and it will need username and email to be configured in `.gitconfig`

Solutions
Before executing `world create`, world cli will check the git configuration is configured or not. if it's not, world cli will tell the command how to configure the git config.

## Brief Changelog

- Create func for checking git configuration
- Call the function at the first execution of `world create` command

## Testing and Verifying
- Added unit test for checkGitConfig func
@zulkhair zulkhair force-pushed the daim/change_docker_compose_using_docker_api_sdk branch from c5b6dbe to 6eee015 Compare September 23, 2024 18:34
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.

3 participants