https://github.com/renddslow/prepare-branch-commit
https://github.com/renddslow/prepare-branch-commit
Last synced: 6 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/renddslow/prepare-branch-commit
- Owner: Renddslow
- Created: 2020-02-03T20:23:45.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-01-31T20:09:02.000Z (over 1 year ago)
- Last Synced: 2024-04-26T20:02:40.219Z (about 1 year ago)
- Language: TypeScript
- Size: 277 KB
- Stars: 1
- Watchers: 2
- Forks: 2
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# prepare-branch-commit
> Add text to commits based on Jira ticket numbers in the branch name.
## Install
```
$ yarn add --dev prepare-branch-commit
```
## Usage
prepare-branch-commit is meant to be run as a Husky hook:
**From Husky v7+**
```bash
npx husky add .husky/prepare-commit-msg 'npx --no-install prepare-branch-commit "$(echo $)1"'
```
**Husky v4 and below**
```json
{
// ...
"husky": {
"prepare-commit-msg": "prepare-branch-commit"
}
// ...
}
```
## Usage Examples
```
branch name: feature/ABC-123-new-screen
commit prefix: [ABC-123]
branch name: hotfix/FUN-456-ABC-123-bugfix-time
commit prefix: [ABC-123] [FUN-456]
```
# GitHub Action Usage
The primary issue tag extraction step can also be used during GitHub Actions to extract issue tags to use as input for other steps. Default usage as follows:
```yaml
steps:
- name: Extract Issue Tags
id: issues-default # usage: ${{ steps.issues-default.outputs.issue-tags }}
uses: Renddslow/[email protected]
```