add installation way

.github/workflows/release.yml

@@ -11,11 +11,11 @@ jobs:
       matrix:
         include:
           - target: x86_64-pc-windows-gnu
-            archive: zip
+            archive: tar.gz
           - target: x86_64-unknown-linux-musl
-            archive: tar.gz tar.xz
+            archive: tar.gz
           - target: x86_64-apple-darwin
-            archive: zip
+            archive: tar.gz
     steps:
       - uses: actions/checkout@master
       - name: Compile and release

README.md

@@ -4,13 +4,14 @@
 
 CLI tool for generating yup definitions from openapi3.yaml
 
-# Install
+# Installation
 
-//TBD
 
-You can download binary from [release](https://github.com/igtm/openapi-yup-generator/releases).
+```sh
+curl -sfL https://raw.githubusercontent.com/igtm/openapi-yup-generator/master/install.sh | sudo sh -s -- -b=/usr/local/bin
+```
 
-I will setup easy ways to install...
+You can also download old version binary from [release](https://github.com/igtm/openapi-yup-generator/releases).
 
 # Usage
 

install.sh

@@ -0,0 +1,100 @@
+#!/bin/sh
+
+set -e
+
+if [ $# -eq 0 ]; then
+    echo "ERROR: Need to specify the install repository"
+    exit 1
+fi
+
+owner="igtm"
+repo="openapi-yup-generator"
+exe_name="openapi-yup-generator"
+githubUrl="https://github.com"
+version=""
+executable_folder="/usr/local/bin" # Eventually, the executable file will be placed here
+
+get_arch() {
+    # darwin/amd64: Darwin axetroydeMacBook-Air.local 20.5.0 Darwin Kernel Version 20.5.0: Sat May  8 05:10:33 PDT 2021; root:xnu-7195.121.3~9/RELEASE_X86_64 x86_64
+    # linux/amd64: Linux test-ubuntu1804 5.4.0-42-generic #46~18.04.1-Ubuntu SMP Fri Jul 10 07:21:24 UTC 2020 x86_64 x86_64 x86_64 GNU/Linux
+    a=$(uname -m)
+    case ${a} in
+        "x86_64" | "amd64" )
+            echo "x86_64"
+        ;;
+        # "i386" | "i486" | "i586")
+        #     echo "386"
+        # ;;
+        # "aarch64" | "arm64" | "arm")
+        #     echo "arm64"
+        # ;;
+        *)
+            echo ${NIL}
+        ;;
+    esac
+}
+
+get_os(){
+    # darwin: Darwin
+    a=$(uname -s | awk '{print tolower($0)}')
+    case ${a} in
+        "darwin")
+            echo "apple-darwin"
+        ;;
+        "windows")
+            echo "pc-windows-gnu"
+        ;;
+        "linux")
+            echo "unknown-linux-musl"
+        ;;
+        *)
+            echo ${NIL}
+        ;;
+    esac
+}
+
+# parse flag
+for i in "$@"; do
+    case $i in
+        -b=*)
+            executable_folder="${i#*=}"
+            shift # past argument=value
+        ;;
+        *)
+            # unknown option
+        ;;
+    esac
+done
+
+downloadFolder="/tmp"
+mkdir -p ${downloadFolder} # make sure download folder exists
+os=$(get_os)
+arch=$(get_arch)
+
+# latest version: (eg: v1.0.0)
+latest_semver=$(
+    command curl -sSf ${githubUrl}/${owner}/${repo}/releases |
+    command grep -o -E "\/${owner}\/${repo}\/tree\/(v[0-9]+\.){1}[0-9]+(\.[0-9]+)?" |
+    command grep -o -E "(v[0-9]+\.){1}[0-9]+(\.[0-9]+)?" |
+    command head -n 1
+)
+if [[ ! "$latest_semver" ]]; then exit 1; fi
+
+
+file_name="${exe_name}_${latest_semver}_${arch}-${os}.tar.gz" # the file name should be download
+downloaded_file="${downloadFolder}/${file_name}" # the file path should be download
+asset_uri="${githubUrl}/${owner}/${repo}/releases/download/${latest_semver}/${file_name}"
+
+echo "[1/3] Download ${asset_uri} to ${downloadFolder}"
+rm -f ${downloaded_file}
+curl --fail --location --output "${downloaded_file}" "${asset_uri}"
+
+echo "[2/3] Install ${exe_name} to the ${executable_folder}"
+tar -xz -f ${downloaded_file} -C ${executable_folder}
+exe=${executable_folder}/${exe_name}
+chmod +x ${exe}
+
+echo "[3/3] Set environment variables"
+echo "${exe_name} was installed successfully to ${exe}"
+
+exit 0