Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/quotidian-ennui/gh-squash-merge
Squash+Merge a PR with a commit based on the PR body
https://github.com/quotidian-ennui/gh-squash-merge
gh-extension
Last synced: 3 months ago
JSON representation
Squash+Merge a PR with a commit based on the PR body
- Host: GitHub
- URL: https://github.com/quotidian-ennui/gh-squash-merge
- Owner: quotidian-ennui
- License: wtfpl
- Created: 2023-10-20T08:35:58.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-08-05T01:04:59.000Z (3 months ago)
- Last Synced: 2024-08-05T02:55:34.720Z (3 months ago)
- Topics: gh-extension
- Language: Shell
- Homepage:
- Size: 54.7 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# gh-squash-merge
I use squash merge a lot when messing around with pull requests. One of the things that has irked me is the _manual love_ that we need to sometimes apply when doing the commit message on merge. If you do not have structured commit messages and it's multiple commits you want to squash merge, then you effectively have to stop and think at the point of merge. Thinking can be hard; I don't like hard, and this kind of problem seems like toil that can be automated away.
You need to have some kind of discipline in place in order to seamlessly 'just use an aggregation of all your commit messages on that PR branch'. I'm all for discipline but perhaps along the journey of your development you've actually changed your mind a couple of times, and text you write _in the PR body_ is actually more meaningful than the commit messages you've written previously.
This is an extension for [GitHub CLI](https://cli.github.com/) that just parses your PR body for some meaningful text and uses that as the commit message when you squash merge.
## Installation
- [GitHub CLI](https://cli.github.com/) is already installed and authenticated
- `awk` is available, untested with awk on MacOS; but I don't think I'm doing anything _special_ in `awk`...
- `mktemp` is available, untested with `mktemp` on MacOS; but `--tmpdir` isn't that special right?
- `gh extension install quotidian-ennui/gh-squash-merge`
## Setup
You probably want to have a `pull_request_template.md` available in your repo / organisation that looks something like this; it should be self-explanatory what the boundary markers are and what the point of them are...
```markdown
# Motivation
## Changes
```
- Any text that you write between the `SQUASH_MERGE_START` & `SQUASH_MERGE_END` will be used as the commit message.
### Usage
```text
Usage: gh squash-merge [ | | ] [flags]
Issues a squash merge on the PR.
Without an argument, the pull request that belongs to the current branch
is used.
Arguments
The PR number to squash merge
The PR URL to squash merge
The branch of PR URL to squash merge
Flags
--admin Use administrator privileges to merge a pull request that does not meet requirement
--auto Automatically merge only after necessary requirements are met
-R, --repo [HOST/]OWNER/REPO Select another repository using the [HOST/]OWNER/REPO format
--dry-run dry run; in effect print the message that would be used for the squash commit
Notes:
- The title of the commit will be based on GitHub repository settings
- The PR body contains a section similar to the following which lets us autogenerate
squash merge commit message
- If PR body does not contain a section similar an empty body will be set
- this forms the body of the commit message and could be multiple lines
but generally we tend towards
- doc: conventional commit messages
EXAMPLES
gh squash-merge
gh squash-merge 811
gh squash-merge --repo quotidian-ennui/gh-squash-merge 811
gh squash-merge https://github.com/quotidian-ennui/gh-squash-merge/pull/811
gh squash-merge feature/update
```
## License
See [LICENSE](./LICENSE)