logburn/git-utilities
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

refactor: deprecate release

Browse Source
This commit is contained in:
rkiel
2020-11-26 09:08:35 -05:00
parent 995d4c779e
commit dc31933d78
2 changed files with 23 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
README.md
View File

@@ -4,18 +4,18 @@ This is a collection of simple command-line scripts, bash aliases, and bash util
The command-line scripts include:
* [feature](FEATURE.md) - make working with feature branches easier
* [release](RELEASE.md)- make working with release branches and tags easier
* [xgrep](XGREP.md)- make using `git-grep` easier
* [xfind](XFIND.md)- make using `find` easier
- [feature](FEATURE.md) - make working with feature branches easier
- [release](RELEASE.md)- make working with release branches and tags easier (DEPRECATED)
- [xgrep](XGREP.md)- make using `git-grep` easier
- [xfind](XFIND.md)- make using `find` easier
The command-line scripts are written in Ruby 2.x using just the standard libraries and do not require any gems to be installed.
For OS X users, these should just work out-of-box.
The `bash` utilities come directly from the [git source contrib](https://github.com/git/git/tree/master/contrib) and include:
* support for [tab completion](https://github.com/git/git/tree/master/contrib/completion/git-completion.bash)
* support for repository status in your [shell prompt](https://github.com/git/git/tree/master/contrib/completion/git-prompt.sh)
- support for [tab completion](https://github.com/git/git/tree/master/contrib/completion/git-completion.bash)
- support for repository status in your [shell prompt](https://github.com/git/git/tree/master/contrib/completion/git-prompt.sh)
## Installation
@@ -30,12 +30,12 @@ To update your `.bash_profile` and `.bashrc`.
```
cd ~/GitHub/rkiel/git-utilities
./install/bin/setup --user $USER
./install/bin/setup $USER
```
## Documention
* [See feature](FEATURE.md)
* [See release](RELEASE.md)
* [See xgrep](XGREP.md)
* [See xfind](XFIND.md)
- [See feature](FEATURE.md)
- [See release](RELEASE.md) (DEPRECATED)
- [See xgrep](XGREP.md)
- [See xfind](XFIND.md)

3
RELEASE.md
View File

@@ -2,6 +2,8 @@
## Release
NOTE: This command is DEPRECATED.
`release` is a command line utility to make working with releases easier. Releases are built and managed using branches and tags.
Official release versions are tagged using a simplified [Semantic Versioning](http://semver.org/) format. The tags start with the letter `v` followed by MAJOR.MINOR.PATCH.
@@ -51,6 +53,7 @@ The `version` specified must be an existing official release version. The `majo
git checkout master
release start patch from 1.0.0
```
or
```bash