docs: add installers and instructions

Author: idc101

build.sbt

@@ -1,7 +1,7 @@
 import Dependencies._
 
 ThisBuild / scalaVersion := "2.12.11"
-ThisBuild / version := "0.6.0"
+ThisBuild / version := "0.5.1"
 ThisBuild / organization := "net.cardnell"
 
 lazy val root = (project in file("."))

build.sh

@@ -8,23 +8,43 @@ version=`git mkver next`
 sbt assembly
 
 # Mac
-if [[ "$(uname)" == "Darwin "]]
+if [[ "$(uname)" == "Darwin" ]]
 then
   pushd target
   native-image -H:IncludeResources='.*conf$' --no-fallback -jar scala-2.12/git-mkver-assembly-$version.jar
   mv git-mkver-assembly-$version git-mkver-darwin-amd64-$version
+  cp git-mkver-darwin-amd64-$version git-mkver
+  chmod +x git-mkver
+  tar -cvzf git-mkver-darwin-amd64-$version.tar.gz git-mkver
+  rm git-mkver
   popd
 
   # Linux
   docker run -v $(pwd):/workspace -it git-mkver \
     /bin/bash -c "cd /workspace/target; native-image -H:IncludeResources='.*conf$' --no-fallback -jar scala-2.12/git-mkver-assembly-$version.jar; mv git-mkver-assembly-$version git-mkver-linux-amd64-$version"
+
+  pushd target
+  cp git-mkver-linux-amd64-$version git-mkver
+  chmod +x git-mkver
+  tar -cvzf git-mkver-linux-amd64-$version.tar.gz git-mkver
+  rm git-mkver
+  popd
+
+  DARWIN_SHA256=$(openssl dgst -sha256 target/git-mkver-darwin-amd64-$version.tar.gz | cut -f2 -d' ')
+  LINUX_SHA256=$(openssl dgst -sha256 target/git-mkver-linux-amd64-$version.tar.gz | cut -f2 -d' ')
+
+  sed -i '' -e "s/MKVER_SHA256  = \".*\".freeze/MKVER_SHA256  = \"$DARWIN_SHA256\".freeze/g" etc/Formula/git-mkver.rb
 fi
 
 # Linux
-if [[ "$(uname)" == "Linux "]]
+if [[ "$(uname)" == "Linux" ]]
 then
   pushd target
   native-image -H:IncludeResources='.*conf$' --no-fallback -jar scala-2.12/git-mkver-assembly-$version.jar
   mv git-mkver-assembly-$version git-mkver-linux-amd64-$version
+  cp git-mkver-linux-amd64-$version git-mkver
+  chmod +x git-mkver
+  tar -cvzf git-mkver-linux-amd64-$version.tar.gz git-mkver
+  rm git-mkver
   popd
 fi

docs/_includes/navbar.html

@@ -3,8 +3,9 @@
         <h2><a href="/">Home</a></h2>
         <h2><a href="installation">Installation</a></h2>
         <h2><a href="usage">Usage</a></h2>
-        <h2><a href="common_patterns">Common Patterns</a></h2>
         <h2><a href="config_reference">Config Reference</a></h2>
+        <h2><a href="config_examples">Config Examples</a></h2>
+        <h2><a href="branching_models">Branching Models</a></h2>
         <h2><a href="formats">Version Formatting</a></h2>
     </nav>
 </div>

docs/common_patterns.md renamed to docs/branching_models.md

@@ -1,4 +1,4 @@
-# Usage Patterns
+# Branching Models
 
 Below are some popular git branching development models and how to configure them with git-mkver:
 - master (aka trunk) based development
@@ -29,6 +29,8 @@ The build script run by the build server would look something like:
 
 ```bash
 nextVer=$(git mkver next)
+# patch the version number into files as needed
+git mkver patch
 # build software ...
 # If successful:
 git mkver tag

docs/config_examples.md

@@ -0,0 +1,32 @@
+# Config Examples
+
+Below are some examples of common configuration.
+
+## Patching README.md
+
+I would like to update my README.md and others docs with the latest version number.
+
+```hocon
+defaults {
+  patches: [
+    Docs
+  ]
+}
+patches: [
+  {
+    name: Docs
+    filePatterns: [
+      "README.md"
+      "docs/installation.md"
+    ]
+    find: "\\d+\\.\\d+\\.\\d+"
+    replace: "{Next}"
+  }
+]
+```
+
+# I would like a different version format for docker tags
+
+Docker does not support `+` symbols from semantics versions. Create a
+format for Docker tags. Additionally `master` branch should be a Version
+only while other branches should include build metadata.

docs/formats.md

@@ -7,10 +7,6 @@ For example git is happy with the SemVer standard for tagging but docker does no
 
 All replacements in format strings start with `{` and end with `}`. They are recursively replaced so that one may refer to another.
 
-## Examples
-
-
-
 ## SemVer Formats
 
 The following built in formats conform to the SemVer spec. They cannot be overriden.
@@ -22,7 +18,6 @@ The following built in formats conform to the SemVer spec. They cannot be overri
 | `VersionBuildMetaData` | `{Version}+{BuildMetaData}` |
 | `VersionPreReleaseBuildMetaData` | `{Version}-{PreRelease}+{BuildMetaData}` |
 
-
 ## Built-in Formats 
 
 | Format Token  | Substitution  |
@@ -49,4 +44,4 @@ The following built in formats conform to the SemVer spec. They cannot be overri
 
 All environment variables are available under a set of formats prefixed with `env.`.
 For example `{env.BUILD_NUMBER}` would get the `BUILD_NUMBER` environment variable.
-This is most useful for getting information from build systems.
+This is most useful for getting information from build systems.

docs/installation.md

@@ -1,5 +1,30 @@
 # Installation
 
+## Linux
+
+```bash
+curl -L https://github.com/idc101/git-mkver/releases/download/v0.5.1/git-mkver-darwin-amd64-0.5.1.tar.gz | tar xvz
+sudo mv git-mkver /usr/local/bin
+```
+
+## Mac OS
+
+Install with [Homebrew](https://brew.sh):
+
+```bash
+brew install https://raw.githubusercontent.com/idc101/git-mkver/master/etc/Formula/git-mkver.rb
+```
+
+## Windows
+
+Install with [scoop](https://scoop.sh):
+
+```cmd
+scoop install https://raw.githubusercontent.com/idc101/git-mkver/master/etc/Formula/git-mkver.rb
+```
+
+## Manual
+
 1. Download the binary for your os from the [releases](https://github.com/idc101/git-mkver/releases) page.
 2. Move it to a directory on your path
 

docs/usage.md

@@ -47,8 +47,7 @@ This will apply an annotated tag from the `next` command to the current commit.
 
 If you would like to patch version numbers in files prior to building and tagging then
 you can use the `patch` command. The files to be patched and the replacements are
-defined in the `mkver.yaml` config file. A large number of standard patches come
-pre-defined.
+defined in the `mkver.conf` [config](config) file.
 
 ```bash
 $ git mkver patch

etc/Formula/git-mkver.rb

@@ -0,0 +1,14 @@
+class GitMkver < Formula
+  MKVER_VERSION = "0.5.1".freeze
+  MKVER_SHA256  = "60b12160b0754e5e9d0b631ae0b8537d6aca33a77e6aff240b049c0dac17dbaf".freeze
+
+  desc "Installs git-mkver from pre-built binaries"
+  homepage "https://idc101.github.io/git-mkver/"
+  url "https://github.com/idc101/git-mkver/releases/download/v#{MKVER_VERSION}/git-mkver-darwin-amd64-#{MKVER_VERSION}.tar.gz"
+  version MKVER_VERSION
+  sha256 MKVER_SHA256
+
+  def install
+    bin.install 'git-mkver'
+  end
+end

etc/scoop/git-mkver.json

@@ -0,0 +1,7 @@
+{
+  "version": "0.5.1",
+  "description": "Automatic Semantic Versioning for git based software development",
+  "url": "https://github.com/idc101/git-mkver/releases/download/v0.5.1/git-mkver-windows-amd64-0.5.1.zip",
+  "extract_dir": "git-mkver",
+  "bin": "git-mkver.exe"
+}

etc/shell/install.sh

@@ -0,0 +1,6 @@
+#/bin/bash
+MKVER_VERSION=0.5.1
+curl -L https://github.com/idc101/git-mkver/releases/download/v${MKVER_VERSION}/git-mkver-darwin-amd64-${MKVER_VERSION}.tar.gz -o git-mkver.tar.gz
+tar xvzf git-mkver.tar.gz
+sudo mv git-mkver /usr/local/bin
+rm git-mkver.tar.gz

mkver.conf

@@ -2,6 +2,7 @@
 defaults {
   patches: [
     Sbt
+    Installers
   ]
 }
 patches: [
@@ -11,4 +12,15 @@ patches: [
     find: "version\\s+:=\\s+\".*\""
     replace: "version := \"{Next}\""
   }
+  {
+    name: Installers
+    filePatterns: [
+      "docs/installation.md"
+      "etc/Formula/git-mkver.rb"
+      "etc/scoop/git-mkver.json"
+      "etc/shell/install.sh"
+    ]
+    find: "\\d+\\.\\d+\\.\\d+"
+    replace: "{Next}"
+  }
 ]

src/main/scala/net/cardnell/mkver/CommandLineArgs.scala

@@ -41,7 +41,7 @@ object CommandLineArgs {
   val commandLineOpts: Opts[CommandLineOpts] = (configFile, commands).mapN(CommandLineOpts.apply)
 
   val mkverCommand: Command[CommandLineOpts] = Command(
-    name = "git-mkver",
+    name = s"git-mkver - v${GitMkverVersion}",
     header = "Uses git tags, branch names and commit messages to determine the next version of the software to release"
   ) {
     commandLineOpts

src/main/scala/net/cardnell/mkver/package.scala

@@ -4,4 +4,6 @@ import zio.Has
 
 package object mkver {
   type Git = Has[Git.Service]
+
+  val GitMkverVersion = "0.5.1"
 }