gfpush is an uncomplicated command-line interface (CLI) utility designed to expedite the process of executing git commit && git push origin <branch_name>. It additionally provides support for the conventional commits specification.
go install github.com/y3boy/gfpush@latest
- Include the required file(s) in the staging area using
git add, or usegfpush -a, which functions similarly togit commit -a. - Specify the commit message type using the
-tflag and provide the commit message using-m. - Include the scope of the commit message by specifying it with the
-sflag. (Optional). - To denote a BREAKING CHANGE, utilize the
-eflag, which appends an exclamation mark (!) to the commit message. (Optional). - For adding branch name to commit message use
-bflag.
| Command | Commit message |
|---|---|
gfpush -b -m 'Add OAuth2 via Keycloak' |
branch_name: Add OAuth2 via Keycloak |
gfpush -t 5 -m 'Add OAuth2 via Keycloak' |
feat: Add OAuth2 via Keycloak |
gfpush -e -t 4 -m 'Add Examples unit' |
docs!: Add Examples unit |
gfpush -e -t 5 -s api -m 'Add metrics' |
feat(api)!: Add metrics |
| Value | Type | Description |
|---|---|---|
| 1 | build | Changes that affect the build system or external dependencies |
| 2 | chore | Changes that do not relate to a fix or feature and don't modify src or test files |
| 3 | ci | Continuous integration related |
| 4 | docs | Updates to documentation |
| 5 | feat | New feature is introduced with the changes |
| 6 | fix | Bug fix has occurred |
| 7 | perf | Performance improvements |
| 8 | refactor | Refactored code that neither fixes a bug nor adds a feature |
| 9 | revert | Reverts a previous commit |
| 10 | style | Changes that do not affect the meaning of the code (white-space, missing semi-colons, and so on) |
| 11 | test | Including new or correcting previous tests |