gr2m / octoherd-script-use-pull-request-title-as-default-commit-message

Enables "Default to PR title for squash merge commits" setting in repositories

octoherd-script-use-pull-request-title-as-default-commit-message

Enables use_squash_pr_title_as_default setting for repository

When merging a pull request using the Squash and Merge button, the default commit message depends on how many commits there are in the pull request.

1. If there is a single commit, the commit message is used as the squash commit message.
2. If there are multiple commits, the pull request titles is used as the default commit message.

In May 2022, GitHub introduced the "Default to PR title for squash merge commits" option. This script enables this feature programmatically in all given repositories.

Usage

Minimal usage

npx octoherd-script-use-pull-request-title-as-default-commit-message

Pass all options as CLI flags to avoid user prompts

npx octoherd-script-use-pull-request-title-as-default-commit-message \
  -T ghp_0123456789abcdefghjklmnopqrstuvwxyzA \
  -R "gr2m/*"

Options

option	type	description
--octoherd-token, -T	string	A personal access token (create). Script will create one if option is not set
--octoherd-repos, -R	array of strings	One or multiple space-separated repositories in the form of repo-owner/repo-name. repo-owner/* will find all repositories for one owner. * will find all repositories the user has access to. Will prompt for repositories if not set
--octoherd-bypass-confirms	boolean	Bypass prompts to confirm mutating requests

Contributing

See CONTRIBUTING.md

About Octoherd

@octoherd is project to help you keep your GitHub repositories in line.

License

ISC

octoherd-script-use-pull-request-title-as-default-commit-message's Issues

Add support for `squash_merge_commit_title` and `squash_merge_commit_message`

What’s missing?

3 new properties have been introduced to further customize the squash merge commit message:

1. squash_merge_commit_title
2. squash_merge_commit_message

Why?

Because currently the commit message defaults to the titles of all commits.

Alternatives you tried

n/a