Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/roziscoding/git-goodies
Set of git custom commands to make life easier
https://github.com/roziscoding/git-goodies
Last synced: about 18 hours ago
JSON representation
Set of git custom commands to make life easier
- Host: GitHub
- URL: https://github.com/roziscoding/git-goodies
- Owner: roziscoding
- Created: 2019-01-07T13:35:48.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2022-09-02T13:31:54.000Z (over 2 years ago)
- Last Synced: 2025-01-06T02:12:04.733Z (6 days ago)
- Language: Shell
- Size: 3.91 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# git-goodies
Set of git custom commands to make life easier
- [git-goodies](#git-goodies)
- [Installing](#installing)
- [Commands](#commands)
- [git bump](#git-bump)
- [git bugfix](#git-bugfix)
- [git feature](#git-feature)
- [git hotfix](#git-hotfix)
- [git pop](#git-pop)
- [git publish](#git-publish)
## Installing
1. Clone this:
```sh
git clone [email protected]:rjmunhoz/git-goodies.git
```
2. Enter the newly created folder
```sh
cd git-goodies
```
3. Give the execute permissions to the all of the -git files
```sh
chmod +x git-*
```
4. Add the full path of the git-goodies folder to your PATH environment variable
## Commands
### git bump
**Syntax**
```sh
git bump version_type [message]
```
**Params**
- vesrion_type:
- Description: version type to be used with `npm version version_type`
- Required: yes
- message:
- Description: commit message to be used along with the new version in the format of `vx.x.x - message`
- Required: no
- Default: no message. Commit will only contain the version number
**Usage**
This calls npm with the passed version type and commits it with the optional message and the new version.
### git bugfix
**Syntax**
```sh
git bugfix bugfix_name
```
**Params**
- bugfix_name
- Description: The git-compliant name for the new branch
- Required: yes
**Usage**
This command performs a series of actions to ensure it creates an updated bugfix branch. These are the steps:
- Checks `release` out and pulls its changes
- Checks `master` out and pulls its changes
- Checks `release` out and merges `master` into `release`
- Pushes `release`
- Creates a new branch called `bugfix/bugfix_name`
### git feature
> This follows the exact same steps, syntax and usage as the [git bugfix](#git-bugfix) command, except everything is called `feature`, and not `bugfix`
### git hotfix
**Syntax**
```sh
git hotfix hotfix_name
```
**Params**
- hotfix_name
- Description: The git-compliant name for the hotfix branch
- Required: yes
**Usage**
This command performs a series of actions to ensure it creates an updated bugfix branch. These are the steps:
- Checks `master` out and pulls its changes
- Creates a new branch called `hotfix/hotfix_name`
### git pop
**Syntax**
```sh
git pop
```
**Params**
> No params
**Usage**
This command will call `git stash pop` and save you a few keystrokes :)
### git publish
**Syntax**
`git publish`
**Params**
> No params
**Usage**
This will call `git push -u origin current_branch_name`