Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/gr2m/octoherd-script-use-pull-request-title-as-default-commit-message

Enables "Default to PR title for squash merge commits" setting in repositories
https://github.com/gr2m/octoherd-script-use-pull-request-title-as-default-commit-message

octoherd-script

Last synced: 23 days ago
JSON representation

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

Host: GitHub
URL: https://github.com/gr2m/octoherd-script-use-pull-request-title-as-default-commit-message
Owner: gr2m
License: isc
Created: 2022-06-27T20:32:20.000Z (over 2 years ago)
Default Branch: main
Last Pushed: 2022-09-23T19:41:10.000Z (over 2 years ago)
Last Synced: 2024-10-30T03:42:42.232Z (2 months ago)
Topics: octoherd-script
Language: JavaScript
Homepage:
Size: 36.1 KB
Stars: 2
Watchers: 2
Forks: 1
Open Issues: 1
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

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

> Enables `use_squash_pr_title_as_default` setting for repository

[![@latest](https://img.shields.io/npm/v/octoherd-script-use-pull-request-title-as-default-commit-message.svg)](https://www.npmjs.com/package/octoherd-script-use-pull-request-title-as-default-commit-message)
[![Build Status](https://github.com/gr2m/octoherd-script-use-pull-request-title-as-default-commit-message/workflows/Test/badge.svg)](https://github.com/gr2m/octoherd-script-use-pull-request-title-as-default-commit-message/actions?query=workflow%3ATest+branch%3Amain)

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](https://github.blog/changelog/2022-05-11-default-to-pr-titles-for-squash-merge-commit-messages/). This script enables this feature programmatically in all given repositories.

## Usage

Minimal usage

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

Pass all options as CLI flags to avoid user prompts

```js
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](https://github.com/settings/tokens/new?scopes=repo)). 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](CONTRIBUTING.md)

## About Octoherd

[@octoherd](https://github.com/octoherd/) is project to help you keep your GitHub repositories in line.

## License

[ISC](LICENSE.md)