cloudflare / semver_bash

Semantic Versioning in Bash

semver_bash is a bash parser for semantic versioning

Semantic Versioning 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  

semver_bash's Issues

Logic Reversed?

It seems like the logic is reversed for the functions. As boolean operators i would expect EQ to return 1 if equals LT to return 1 if < and GT to return 1 if GT.

Version without special is greater?

semverGT "2.2.2" "2.2.2-1" returns OK.

I think 2.2.2-1 comes after 2.2.2.

Add support for metadata parsing

It would be nice if metadata (after +) could be parsed as well.

Does not parse some versions properly

Example: 5.5.9-1ubuntu4.1.

recommend bats or bats-assert as shell unit test library.

semverCheck

Could you add a function checking a semver string?

Sorting

This is my bubble sort funtion

declare -a VERSION=( ... )
BUBBLE="1"
while [ "$BUBBLE" == 1 ]; do
    BUBBLE="0"
    for I in $(seq 0 "$((${#VERSIONS[@]} - 1))"); do
        # Skip first element
        [ "$I" == 0 ] && continue

        PREVIOUS="$((I - 1))"
        if semverGT "${VERSIONS[$PREVIOUS]}" "${VERSIONS[$I]}"; then
            BUBBLE="1"
            BUFFER="${VERSIONS[$I]}"
            VERSIONS[$I]="${VERSIONS[$PREVIOUS]}"
            VERSIONS[$PREVIOUS]="$BUFFER"
        fi
    done
done