https://github.com/dcbaker/git-ck
wrapper for git-checkout which managed uncommited changes
https://github.com/dcbaker/git-ck
Last synced: about 2 months ago
JSON representation
wrapper for git-checkout which managed uncommited changes
- Host: GitHub
- URL: https://github.com/dcbaker/git-ck
- Owner: dcbaker
- License: gpl-2.0
- Created: 2015-09-17T20:25:16.000Z (almost 11 years ago)
- Default Branch: master
- Last Pushed: 2015-12-05T01:02:28.000Z (over 10 years ago)
- Last Synced: 2025-03-20T07:17:48.958Z (over 1 year ago)
- Language: Ruby
- Size: 15.6 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# git-ck
wrapper for git-checkout which managed uncommited changes
This wrapper will allow you to change branches with uncommitted changes without fear. It will commit staged and unstaged changes as separate commits, which it will restore when you return to that branch.
## Requirements
It requires ruby, just ruby, no extra gems required. And obviously git.
It was developed against ruby 2.2, but I haven't used any fancy features, so it should work against at least 2.1
## Install
Copy git-ck to somewhere in your path. For Linux uses a good option is either /usr/local/bin (for system-wide install) or ~/.local/bin (for user-specific install)
## Shell completions
### Bash
Copy bash/\_git_ck them to somewhere bash will source them. Unfortunately this is very OS specific (even between linux distributions there is no consensus)
### Zsh
copy the zsh/\_git-ck file to somewhere in your fpath. For example: ~/.local/share/zsh-completions/.
Then ensure that location is at the head of fpath, add the following to your .zshrc (or somewhere that will be sourced by zshrc)
```zsh
fpath=(~/.local/share/zsh-completions/ $fpath)
```
## git hook
This repo provides a git hook to prevent git-ck commits from being pushed. Put git/pre-push.rb in /.git/hooks as "pre-push", and they will abort pushing if their conditions are met. Make sure the script is executable and doesn't have a file extension!
To install this to all repositories for a single user consider something like this:
```sh
mkdir -p ~/.local/share/git/hooks
git config --global init.templatedir ~/.local/share/git
cp git/pre-push.rb ~/.local/share/git/hooks/pre-push
```
This will means all new repositories will use the new git hook. You can call ```git init``` again on a repo to use the new hooks.
Note: You can't use this on git-ck itself, since it has commits prefaced with git-ck: and will always fail.