squashed-merge-message
squashed-merge-message copied to clipboard
Use Pull Request description as Squashed and Merged commit messages.
Squashed Merge Message
Use Pull Request description as Squashed and Merged commit messages.
‼️ Support Notice ‼️
GitHub has native support for controlling the default merge message 🎉
See the GitHub announcement for details.
As such, I recommend all GitHub patrons use GitHub's default merge message feature instead of this web extension to both take advantage of native feature support and avoid any compatibility issues between this web extension and GitHub's implementation.
Support for Squashed Merge Message will continue until GitHub's default merge message feature is added to GitHub Enterprise. At that time, support for Squashed Merge Message will begin to sunset and eventually stop.
Thank you all for your support and contributions! 💙
Install
Details
When merging a PR with either the "Squash and merge" or "Create a merge commit" buttons:
- The commit title and message will be copied from the Pull Request.
- Any leading HTML comments will be removed.
- Co-authors will be de-duplicated and appended.
The final commit on the base branch will look something like:
PR Title (#1234)
PR Body
Co-authored-by: ... (if multiple authors)
GitHub Enterprise
Click on the icon and select
Enable Squashed Merge Message on this domain to enable the extension on your
custom GitHub Enterprise domain.
Refined GitHub Compatibility
In order for this extension to work with Refined GitHub you need to disable the
clear-pr-merge-commit-message feature.
To disable in Chrome
- Go to chrome://extensions
- Open Details for Refined GitHub
- Open Extension options
- Search for and disable
clear-pr-merge-commit-message
To disable in Firefox
- Go to about:addons
- Open Refined Github
- Open Preferences
- Search for and disable
clear-pr-merge-commit-message
Attributions
Icons made by monkik from www.flaticon.com