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

chore: Sync dev-current with main github workflow #179

Merged
merged 8 commits into from
Jan 10, 2025
Merged

Conversation

geertmeersman
Copy link
Owner

@geertmeersman geertmeersman commented Jan 10, 2025

Summary by CodeRabbit

  • Chores
    • Added a new GitHub Actions workflow to automatically synchronize the dev-current branch with the main branch
    • Implemented automated branch management process to ensure consistent branch state
    • Added manual trigger option for branch synchronization

Copy link
Contributor

coderabbitai bot commented Jan 10, 2025

Warning

Rate limit exceeded

@geertmeersman has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 8 minutes and 39 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between bb889d6 and ce2daa4.

📒 Files selected for processing (1)
  • .github/workflows/sync-dev-current.yml (1 hunks)

Walkthrough

A new GitHub Actions workflow has been created to automate the synchronization of the dev-current branch with the main branch. The workflow is designed to run automatically when changes are pushed to the main branch or can be manually triggered. It ensures that the dev-current branch remains aligned with the main branch, with built-in logic to prevent unnecessary updates if the dev-current branch has unique commits.

Changes

File Change Summary
.github/workflows/sync-dev-current.yml New workflow file added to synchronize dev-current branch with main branch

Sequence Diagram

sequenceDiagram
    participant GH as GitHub Actions
    participant Main as main branch
    participant DevCurrent as dev-current branch

    GH->>Main: Push to main branch
    GH->>DevCurrent: Check branch status
    alt DevCurrent has no unique commits
        GH->>DevCurrent: Delete and recreate from main
        GH->>DevCurrent: Push updated branch
    else DevCurrent has unique commits
        GH->>GH: Log number of unique commits
        GH-->>DevCurrent: No sync performed
    end
Loading

Poem

🐰 Sync, sync, little branch so bright,
From main to dev-current, everything's right!
No conflicts, no fuss, just smooth as can be,
A rabbit's workflow, setting branches free!
Git magic dancing, clean and neat 🌿


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

@github-actions github-actions bot added chore Changes to the build process or auxiliary tools and libraries such as documentation generation patch A change requiring a patch version bump labels Jan 10, 2025
Copy link
Contributor

@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: 4

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 58bc4d1 and bb889d6.

📒 Files selected for processing (1)
  • .github/workflows/sync-dev-current.yml (1 hunks)
🔇 Additional comments (2)
.github/workflows/sync-dev-current.yml (2)

1-12: Well-configured workflow triggers and concurrency settings!

The workflow is properly configured with appropriate triggers and concurrency settings to prevent parallel runs and race conditions.


13-26: Proper environment and Git configuration setup!

The job uses the latest Ubuntu runner and properly configures Git with the actions bot identity.

.github/workflows/sync-dev-current.yml Outdated Show resolved Hide resolved
.github/workflows/sync-dev-current.yml Outdated Show resolved Hide resolved
.github/workflows/sync-dev-current.yml Outdated Show resolved Hide resolved
Comment on lines 27 to 72
- name: Sync dev-current with main
run: |
#!/bin/bash

# Fetch the latest updates
echo "INFO: Pulling the latest changes..."
git pull

# Ensure we are on the main branch and update it
echo "INFO: Switching to the main branch..."
git switch main
git pull

# Ensure dev-current branch is up-to-date
echo "INFO: Switching to the dev-current branch..."
if git show-ref --verify --quiet refs/heads/dev-current; then
git switch dev-current
git pull
else
echo "INFO: dev-current branch does not exist."
fi

# Check if dev-current is ahead of main
echo "INFO: Checking if dev-current has unmerged commits..."
ahead=$(git log main..dev-current --oneline | wc -l || echo 0)

if [[ $ahead -gt 0 ]]; then
echo "----------------------------------------------------"
echo "INFO: dev-current is ahead of main by $ahead commits"
echo "INFO: No sync will occur."
echo "Commit list:"
git log --pretty=format:" %h %s" main..dev-current
exit 0
fi

# Sync dev-current with main
echo "INFO: Syncing dev-current with main..."
git switch main
if git show-ref --verify --quiet refs/heads/dev-current; then
git branch -D dev-current
fi
git branch dev-current
git switch dev-current
git push --force --set-upstream origin dev-current

echo "INFO: dev-current successfully synced with main."
Copy link
Contributor

Choose a reason for hiding this comment

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

🛠️ Refactor suggestion

Add error handling for Git operations

The script should handle potential Git operation failures. Consider adding error handling for critical operations:

+handle_error() {
+  echo "ERROR: Command failed: $1"
+  exit 1
+}
+
 # Fetch the latest updates
 echo "INFO: Pulling the latest changes..."
-git pull
+git pull || handle_error "git pull failed"
 
 # Ensure we are on the main branch and update it
 echo "INFO: Switching to the main branch..."
-git switch main
-git pull
+git switch main || handle_error "Failed to switch to main branch"
+git pull || handle_error "Failed to update main branch"

Also, consider adding a cleanup function to handle interrupts:

+cleanup() {
+  echo "INFO: Cleaning up..."
+  # Return to original branch if possible
+  git switch - 2>/dev/null || true
+}
+
+trap cleanup EXIT INT TERM
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
- name: Sync dev-current with main
run: |
#!/bin/bash
# Fetch the latest updates
echo "INFO: Pulling the latest changes..."
git pull
# Ensure we are on the main branch and update it
echo "INFO: Switching to the main branch..."
git switch main
git pull
# Ensure dev-current branch is up-to-date
echo "INFO: Switching to the dev-current branch..."
if git show-ref --verify --quiet refs/heads/dev-current; then
git switch dev-current
git pull
else
echo "INFO: dev-current branch does not exist."
fi
# Check if dev-current is ahead of main
echo "INFO: Checking if dev-current has unmerged commits..."
ahead=$(git log main..dev-current --oneline | wc -l || echo 0)
if [[ $ahead -gt 0 ]]; then
echo "----------------------------------------------------"
echo "INFO: dev-current is ahead of main by $ahead commits"
echo "INFO: No sync will occur."
echo "Commit list:"
git log --pretty=format:" %h %s" main..dev-current
exit 0
fi
# Sync dev-current with main
echo "INFO: Syncing dev-current with main..."
git switch main
if git show-ref --verify --quiet refs/heads/dev-current; then
git branch -D dev-current
fi
git branch dev-current
git switch dev-current
git push --force --set-upstream origin dev-current
echo "INFO: dev-current successfully synced with main."
- name: Sync dev-current with main
run: |
#!/bin/bash
handle_error() {
echo "ERROR: Command failed: $1"
exit 1
}
cleanup() {
echo "INFO: Cleaning up..."
# Return to original branch if possible
git switch - 2>/dev/null || true
}
trap cleanup EXIT INT TERM
# Fetch the latest updates
echo "INFO: Pulling the latest changes..."
git pull || handle_error "git pull failed"
# Ensure we are on the main branch and update it
echo "INFO: Switching to the main branch..."
git switch main || handle_error "Failed to switch to main branch"
git pull || handle_error "Failed to update main branch"
# Ensure dev-current branch is up-to-date
echo "INFO: Switching to the dev-current branch..."
if git show-ref --verify --quiet refs/heads/dev-current; then
git switch dev-current
git pull
else
echo "INFO: dev-current branch does not exist."
fi
# Check if dev-current is ahead of main
echo "INFO: Checking if dev-current has unmerged commits..."
ahead=$(git log main..dev-current --oneline | wc -l || echo 0)
if [[ $ahead -gt 0 ]]; then
echo "----------------------------------------------------"
echo "INFO: dev-current is ahead of main by $ahead commits"
echo "INFO: No sync will occur."
echo "Commit list:"
git log --pretty=format:" %h %s" main..dev-current
exit 0
fi
# Sync dev-current with main
echo "INFO: Syncing dev-current with main..."
git switch main
if git show-ref --verify --quiet refs/heads/dev-current; then
git branch -D dev-current
fi
git branch dev-current
git switch dev-current
git push --force --set-upstream origin dev-current
echo "INFO: dev-current successfully synced with main."

geertmeersman and others added 6 commits January 10, 2025 11:14
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
@geertmeersman geertmeersman merged commit e6ad4bc into main Jan 10, 2025
3 of 4 checks passed
@geertmeersman geertmeersman deleted the dev-current branch January 10, 2025 10:26
@geertmeersman geertmeersman restored the dev-current branch January 10, 2025 10:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
chore Changes to the build process or auxiliary tools and libraries such as documentation generation patch A change requiring a patch version bump
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant