๐ Bug: Created repos default to incorrect merge commit messages
Closed this issue ยท 2 comments
Bug Report Checklist
- I have tried restarting my IDE and the issue persists.
- I have pulled the latest
main
branch of the repository. - I have searched for related issues and found none that matched my issue.
Expected
This template relies on conventional commits for releasing:
- PR titles are enforced to have semantic names (https://github.com/mtfoley/pr-compliance-action/)
- The release script (https://github.com/JoshuaKGoldberg/should-semantic-release) checks commit messages from the recent Git history to determine whether a package should be released.
Therefore, it's important that PR merge messages adhere to the PR title of the merged PR. Otherwise nothing will get released!
Actual
I created a new repo this week, https://github.com/JoshuaKGoldberg/prettier-plugin-curly, and its settings for PR just goes with the default merge commit title. Example from JoshuaKGoldberg/prettier-plugin-curly@d5486a8:
Merge pull request #12 from JoshuaKGoldberg/all-contributors/add-so1ve
docs: add so1ve as a contributor for bug
We want to instead default to the PR title and description, per https://github.blog/changelog/2022-08-23-new-options-for-controlling-the-default-commit-message-when-merging-a-pull-request/.
docs: add so1ve as a contributor for bug
etc. etc.
Additional Info
https://docs.github.com/en/rest/repos/repos?apiVersion=2022-11-28#update-a-repository mentions how to do this in the GitHub API. If the API doesn't work, it should be documented as part of setup in the README that you should do this manually. But it looks like the API should be enough.