Skip to content
This repository has been archived by the owner on Jan 24, 2023. It is now read-only.

Latest commit

 

History

History
65 lines (39 loc) · 2.72 KB

README.md

File metadata and controls

65 lines (39 loc) · 2.72 KB

Squashed Merge Message

Use Pull Request description as Squashed and Merged commit messages.

‼️ Support for Squashed Merge Message has ended ‼️

GitHub has native support for controlling the default merge message 🎉

See the GitHub announcement for details.

And the GitHub Enterprise 3.7 release notes

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.

Thank you all for your support and contributions! 💙

Install

Chrome extension Chrome Web Store

Firefox add-on Mozilla Add-on

Details

When merging a PR with either the "Squash and merge" or "Create a merge commit" buttons:

  1. The commit title and message will be copied from the Pull Request.
  2. Any leading HTML comments will be removed.
  3. 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

  1. Go to chrome://extensions
  2. Open Details for Refined GitHub
  3. Open Extension options
  4. Search for and disable clear-pr-merge-commit-message

To disable in Firefox

  1. Go to about:addons
  2. Open Refined Github
  3. Open Preferences
  4. Search for and disable clear-pr-merge-commit-message

Attributions

Icons made by monkik from www.flaticon.com