misc: Add Workflow to give merging advice #426
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
In response to discussions in https://github.com/orgs/gem5/discussions/261, `Squash Merges` have been enabled. This adds a GitHub Action to add a comment to a PR when the commit is in a mergable state explaining which strategy `Merge` or `Squash Merge` is preferable. Change-Id: I6537e351c02cd059e1ecd71f1d11ca6b08fa1f00
BobbyRBruce
added
the
github
powerjg
reviewed
Oct 10, 2023
| jobs: | ||
| write-single-commit-commment: | ||
| # Only run when the pull request is mergeable and has one commit | ||
| if: github.event.pull_request.mergeable == true && github.event.pull_request.comments == 1 |
There was a problem hiding this comment.
Do all single commit changes have a single comment? What happens if I comment on a PR, wouldn't that mean there would be >1 comment?
How about "commits"? See https://docs.github.com/en/webhooks/webhook-events-and-payloads#pull_request
| issue_number: context.issue.number, | ||
| owner: context.repo.owner, | ||
| repo: context.repo.repo, | ||
| body: 'This PR is now in a mergeable state. As it as a multi-commit PR, we recommend using the `Merge`. Please ensure the title and description of the merge commit (defaulted to the PR title and description) is sufficient to describe the collection of patches. `Squash` may be used if you wish to squash all the commits into a single commit.' |
There was a problem hiding this comment.
You may want to add some information about when someone should squash vs merge.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
In response to discussions in
https://github.com/orgs/gem5/discussions/261,
Squash Mergeshave been enabled.This adds a GitHub Action to add a comment to a PR when the commit is in a mergable state explaining which strategy
MergeorSquash Mergeis preferable.