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

DM-49411: Add the rebase_checker workflow #4330

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

Conversation

jonathansick
Copy link
Member

This reusable workflow checks if the main branch has been merged into a PR's branch. This commonly happens when folks update their branch with the GitHub UI. The downside of this approach is that it makes Git history really hard to understand in a PR because commits from main are intermixed with new commits. This workflows encourages people to use the rebases, with a link to the Developer Guide.

This reusable workflow checks if the main branch has been merged into a
PR's branch. This commonly happens when folks update their branch with
the GitHub UI. The downside of this approach is that it makes Git
history really hard to understand in a PR because commits from main are
intermixed with new commits. This workflows encourages people to use the
rebases, with a link to the Developer Guide.
@jonathansick jonathansick requested a review from rra March 10, 2025 20:09
Copy link
Member

@rra rra left a comment

Choose a reason for hiding this comment

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

Looks good, thank you! I have no idea what failed last time. Maybe I was trying to make it mandatory and ran into problems with the merge queue?

@jonathansick
Copy link
Member Author

Hmm. I'll make it required and see if it merges ok.

@jonathansick jonathansick added this pull request to the merge queue Mar 10, 2025
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Mar 10, 2025
@jonathansick
Copy link
Member Author

Yep, that's the issue: gsactions/commit-message-checker@v2 doesn't work in a merge group. I'll see if there's a way to skip the rule in a merge_group context.

The gsactions/commit-message-checker@v2 within the rebase_checker
workflow is not compatible with merge_group. This is a way around that
by having the workflow skip execution when part of a merge group.
@jonathansick jonathansick added this pull request to the merge queue Mar 10, 2025
github-merge-queue bot pushed a commit that referenced this pull request Mar 10, 2025
DM-49411: Add the rebase_checker workflow
@jonathansick jonathansick removed this pull request from the merge queue due to a manual request Mar 10, 2025
@jonathansick
Copy link
Member Author

When I tried skipping the rebase checker from the merge_group trigger I found that the merge queue would just hang. So I'm stuck at the same place you got to, unfortunately.

@rra
Copy link
Member

rra commented Mar 10, 2025

Oh, right, that's what it was. I think we can make it optional but not mandatory. Making it optional would still at least send a warning to the person making the PR that it failed, and would warn reviewers, so that may be worth doing.

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