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: The command-line scripts include:
* [feature](FEATURE.md) - make working with feature branches easier - [feature](FEATURE.md) - make working with feature branches easier
* [release](RELEASE.md)- make working with release branches and tags easier - [release](RELEASE.md)- make working with release branches and tags easier (DEPRECATED)
* [xgrep](XGREP.md)- make using `git-grep` easier - [xgrep](XGREP.md)- make using `git-grep` easier
* [xfind](XFIND.md)- make using `find` 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. 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. 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: 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 [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 repository status in your [shell prompt](https://github.com/git/git/tree/master/contrib/completion/git-prompt.sh)
## Installation ## Installation
@@ -30,12 +30,12 @@ To update your `.bash_profile` and `.bashrc`.
``` ```
cd ~/GitHub/rkiel/git-utilities cd ~/GitHub/rkiel/git-utilities
./install/bin/setup --user $USER ./install/bin/setup $USER
``` ```
## Documention ## Documention
* [See feature](FEATURE.md) - [See feature](FEATURE.md)
* [See release](RELEASE.md) - [See release](RELEASE.md) (DEPRECATED)
* [See xgrep](XGREP.md) - [See xgrep](XGREP.md)
* [See xfind](XFIND.md) - [See xfind](XFIND.md)

21
RELEASE.md
View File

@@ -2,11 +2,13 @@
## Release ## Release
`release` is a command line utility to make working with releases easier. Releases are built and managed using branches and tags. NOTE: This command is DEPRECATED.
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. `release` is a command line utility to make working with releases easier. Releases are built and managed using branches and tags.
Before a release is tagged with a version, a release candidate branch can be created and used for development. The intent of the release candidate branch is to be short-term support for multiple developers and deployment to test environments. They are prefixed by `rc`. 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.
Before a release is tagged with a version, a release candidate branch can be created and used for development. The intent of the release candidate branch is to be short-term support for multiple developers and deployment to test environments. They are prefixed by `rc`.
### Usage ### Usage
@@ -30,7 +32,7 @@ Create an official release tag.
release create version release create version
``` ```
You must be on the `master` branch. The latest code will be pulled from `master` and a tag created for the last commit. For example, the following command will create a `v1.0.0` tag. You must be on the `master` branch. The latest code will be pulled from `master` and a tag created for the last commit. For example, the following command will create a `v1.0.0` tag.
```bash ```bash
git checkout master git checkout master
@@ -45,12 +47,13 @@ Create a shared, release candidate branch.
release start (major|minor|patch) from version [using master] release start (major|minor|patch) from version [using master]
``` ```
The `version` specified must be an existing official release version. The `major`, `minor`, and `patch` options will increment the new version number accordingly. For example, to create a patch update, the following command will create a `rc1.0.1` release candidate branch. If the optional `using master` is not specified, the release candiate branch will be created from the version tag (e.g. `v1.0.0`). Otherwise, the release candiate branch will be created from `master`. Also, if the repository contains a `package.json` file, the `version` property will automatically be set and committed. The `version` specified must be an existing official release version. The `major`, `minor`, and `patch` options will increment the new version number accordingly. For example, to create a patch update, the following command will create a `rc1.0.1` release candidate branch. If the optional `using master` is not specified, the release candiate branch will be created from the version tag (e.g. `v1.0.0`). Otherwise, the release candiate branch will be created from `master`. Also, if the repository contains a `package.json` file, the `version` property will automatically be set and committed.
```bash ```bash
git checkout master git checkout master
release start patch from 1.0.0 release start patch from 1.0.0
``` ```
or or
```bash ```bash
@@ -68,7 +71,7 @@ Join in on using a shared, release candidate branch that someone else has previo
release join version release join version
``` ```
The `version` specified must be an existing release candidate branch version. A local tracking branch will be created. For example, the following command will create `rc1.0.1` as a local tracking branch. The `version` specified must be an existing release candidate branch version. A local tracking branch will be created. For example, the following command will create `rc1.0.1` as a local tracking branch.
```bash ```bash
git checkout master git checkout master
@@ -85,7 +88,7 @@ Stop using a shared, release candidate branch but leave it intact for others to
release leave release leave
``` ```
Your local tracking branch will be forcibly removed. If there are any local changes on the branch, they will be lost. For example, the following command will remove `rc1.0.1` as a local tracking branch. Your local tracking branch will be forcibly removed. If there are any local changes on the branch, they will be lost. For example, the following command will remove `rc1.0.1` as a local tracking branch.
```bash ```bash
git checkout rc1.0.1 git checkout rc1.0.1
@@ -100,7 +103,7 @@ Finish the release candidate and create an official release.
release finish release finish
``` ```
The latest code from the release candidate branch will be pulled and a tag created. The shared release candidate branch will then be removed. For example, the following command will create `v1.0.1` version tag and removed `rc1.0.1` branch. The latest code from the release candidate branch will be pulled and a tag created. The shared release candidate branch will then be removed. For example, the following command will create `v1.0.1` version tag and removed `rc1.0.1` branch.
```bash ```bash
git checkout rc1.0.1 git checkout rc1.0.1
@@ -123,7 +126,7 @@ Throw away the release candidate.
release trash local-branch-confirmation release trash local-branch-confirmation
``` ```
The shared release candidate branch will be forcibly removed and no version tag will be created. The release candidate branch must be checked out and entered as the `local-branch-confirmation`. For example, the following command will remove the `rc1.0.1` release candidate branch. The shared release candidate branch will be forcibly removed and no version tag will be created. The release candidate branch must be checked out and entered as the `local-branch-confirmation`. For example, the following command will remove the `rc1.0.1` release candidate branch.
```branch ```branch
git checkout rc1.0.1 git checkout rc1.0.1