summaryrefslogtreecommitdiff
path: root/deps/semver_bash/README.md
blob: 180c368964a86494b96d1fb1cfc14316c7207a6f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
semver_bash is a bash parser for semantic versioning
====================================================

[Semantic Versioning](http://semver.org/) is a set of guidelines that help keep
version and version management sane. This is a bash based parser to help manage
a project's versions. Use it from a Makefile or any scripts you use in your
project.

Usage
-----
semver_bash can be used from the command line as:  

    $ ./semver.sh "3.2.1" "3.2.1-alpha"  
    3.2.1 -> M: 3 m:2 p:1 s:  
    3.2.1-alpha -> M: 3 m:2 p:1 s:-alpha  
    3.2.1 == 3.2.1-alpha -> 1.  
    3.2.1 < 3.2.1-alpha -> 1.  
    3.2.1 > 3.2.1-alpha -> 0.


Alternatively, you can source it from within a script:

    . ./semver.sh  
    
    local MAJOR=0  
    local MINOR=0  
    local PATCH=0  
    local SPECIAL=""
    
    semverParseInto "1.2.3" MAJOR MINOR PATCH SPECIAL  
    semverParseInto "3.2.1" MAJOR MINOR PATCH SPECIAL