deploy.sh code release git deploy #32

add --replace, first delete existing release
now support release compilation too in build/ dir
completed desciption on deployment.yml

Author: Sylvain Viart

Makefile

@@ -44,4 +44,4 @@ README.md: examples/legacy_bash/rock_hello_world.sh examples/legacy_bash/rock_he
 	mv README.tmp README.md
 
 clean:
-	rm -f docopts-* docopts README.tmp build/docopts_*
+	rm -f docopts-* docopts README.tmp build/*

deploy.sh

@@ -2,18 +2,21 @@
 #
 # Tools for deploying our release to github
 #
-# Usage: ./deploy.sh deploy [-n] [-r REMOTE_REPOS] [RELEASE_VERSION]
-#        ./deploy.sh build
+# Usage: ./deploy.sh deploy [-n] [-r REMOTE_REPOS] [--replace] [RELEASE_VERSION]
+#        ./deploy.sh build [RELEASE_VERSION]
 #
 # Options:
 #   -n                   Dry run, show with version, files and description
 #   -r REMOTE_REPOS      Specify a REMOTE_REPOS name [default: origin]
+#   --replace            Replace existing release with this one, previous release
+#                        will be deleted first.
 #
 # Arguments:
 #   RELEASE_VERSION      a git tag
 #
 # Actions:
-#   build  only build using gox and deployment.yml config
+#   build      only build using gox and deployment.yml config
+#   deploy     prepare and deploy the release
 #
 # deploy.sh read description in deployment.yml
 
@@ -26,27 +29,53 @@ BUILD_DEST_DIR=build
 
 create_release()
 {
+  local release="$1"
+  local name="$2"
+  local description="$3"
+
+  # TODO: detect alpha ==> pre-release
   gothub release \
       --user $GITHUB_USER \
       --repo $GITHUB_REPO \
-      --tag $TAG \
-      --name "docopt for shell Bash" \
-      --description "Written in Go. This binaries is for GNU/Linux 32bits and 64bits" \
+      --tag "$release" \
+      --name "$name" \
+      --description "$description" \
       --pre-release
 }
 
+check_release()
+{
+  local release=$1
+  gothub info \
+      --user $GITHUB_USER \
+      --repo $GITHUB_REPO \
+      --tag "$release" > /dev/null 2>&1
+}
+
+delete_release()
+{
+  local release=$1
+  gothub delete \
+      --user $GITHUB_USER \
+      --repo $GITHUB_REPO \
+      --tag "$release"
+}
+
 prepare_upload()
 {
   local build_dest_dir=$1
   pushd $build_dest_dir > /dev/null
-  rm -f sha256sum.txt
+  # remove docopts source used for build
+  rm -f sha256sum.txt docopts.go
   sha256sum * > sha256sum.txt
   popd > /dev/null
   find $build_dest_dir -type f -a ! -name .\*
 }
 
 upload_binaries()
 {
+  local release=$1
+  shift
   local filenames=$*
 
   local f
@@ -56,9 +85,9 @@ upload_binaries()
     gothub upload \
         --user $GITHUB_USER \
         --repo $GITHUB_REPO \
-        --tag $TAG \
-        --name "$f" \
-        --file $f \
+        --tag "$release" \
+        --name "$(basename $f)" \
+        --file "$f" \
         --replace
   done
 }
@@ -86,59 +115,96 @@ get_arch_build_target()
 
 build_binaries()
 {
-  gox -osarch "$(get_arch_build_target gox)" -output="$BUILD_DEST_DIR/{{.Dir}}_{{.OS}}_{{.Arch}}"
+  local release=$1
+  local build_dest_dir=$2
+  # checkout release version
+  git show $release:./docopts.go > $build_dest_dir/docopts.go
+  local osarch="$(get_arch_build_target gox)"
+  pushd $build_dest_dir > /dev/null
+  gox -osarch "$osarch" -output="docopts_{{.OS}}_{{.Arch}}"
+  popd > /dev/null
 }
 
 yaml_keys ()
 {
   yq.v2 r "$1" "$2" | sed -n -e '/^\([^ ]\([^:]\+\)\?\):/  s/:.*// p'
 }
 
-main_deploy()
+show_release_data()
 {
-  # redefine GITHUB_TOKEN to test if exported for strict mode
-  GITHUB_TOKEN=${GITHUB_TOKEN:-}
-
-  if [[ -n $ARGS_RELEASE_VERSION ]] ; then
-    TAG=$ARGS_RELEASE_VERSION
-  else
-    # fetch last tag from git
-    TAG=$(git describe --abbrev=0)
-  fi
+  local release=$1
+  local name="$2"
+  local description="$3"
 
-  repository=$(git remote -v | grep $ARGS_REMOTE_REPOS | grep push | head -1)
-  description=$(yq.v2 r $DEPLOYMENT_FILE "releases[$TAG].description")
-  if [[ -z $description || $description == null ]] ; then
-    echo "description not found for tag '$TAG' in $DEPLOYMENT_FILE"
-    echo "available git tags: ($repository)"
-    indent "$(git tag)"
-    echo "available git tags in $DEPLOYMENT_FILE:"
-    indent "$(yaml_keys $DEPLOYMENT_FILE releases)"
-    return 1
-  fi
-
-  build_binaries
-  UPLOAD_FILES=$(prepare_upload $BUILD_DEST_DIR)
+  local repository=$(git remote -v | grep $ARGS_REMOTE_REPOS | grep push | head -1)
 
-  if $ARGS_n ; then
-    cat << EOT
+  cat << EOT
 GITHUB_TOKEN: $GITHUB_TOKEN
 build_dir: $BUILD_DEST_DIR
 repository: $repository
-tag: $TAG
+name: $name
+tag: $release
 files: $UPLOAD_FILES
 sha256sum.txt:
 $(indent $BUILD_DEST_DIR/sha256sum.txt)
 description:
 $(indent "$description")
 EOT
+}
+
+check_name_description()
+{
+  local name="$1"
+  local description="$2"
+  if [[ -z $description || $description == null || -z $name || $name == null ]] ; then
+    echo "description or name not found for tag '$TAG' in $DEPLOYMENT_FILE"
+    echo "available git tags:"
+    indent "$(git tag)"
+    echo "available git tags in $DEPLOYMENT_FILE:"
+    indent "$(yaml_keys $DEPLOYMENT_FILE releases)"
+    return 1
+  fi
+}
+
+main_deploy()
+{
+  # redefine GITHUB_TOKEN to test if exported for strict mode
+  GITHUB_TOKEN=${GITHUB_TOKEN:-}
+
+  local description=$(yq.v2 r $DEPLOYMENT_FILE "releases[$TAG].description")
+  local name=$(yq.v2 r $DEPLOYMENT_FILE "releases[$TAG].name")
+
+  check_name_description "$name" "$description"
+
+  build_binaries $TAG $BUILD_DEST_DIR
+  UPLOAD_FILES=$(prepare_upload $BUILD_DEST_DIR)
+
+  if $ARGS_n ; then
+    show_release_data $TAG "$name" "$description"
     exit 0
   else
     if [[ -z $GITHUB_TOKEN ]] ; then
       echo "GITHUB_TOKEN must be exported"
       return 1
     fi
-    upload_binaries $UPLOAD_FILES
+
+    if check_release $TAG ; then
+      echo "release: already $TAG exists"
+      if $ARGS_replace ; then
+        echo "deleting existing release $TAG"
+        delete_release $TAG
+        echo "creating release $TAG"
+        create_release $TAG "$name" "$description"
+      else
+        echo "use --replace to replace the existing release"
+        echo "only upload new files"
+      fi
+    else
+      echo "release: $TAG doesn't exists yet"
+      echo "creating release $TAG ..."
+      create_release $TAG "$name" "$description"
+    fi
+    upload_binaries $TAG $UPLOAD_FILES
   fi
 }
 
@@ -155,10 +221,17 @@ if [[ $0 == $BASH_SOURCE ]] ; then
 
   docopt_print_ARGS -G
 
+  if [[ -n $ARGS_RELEASE_VERSION ]] ; then
+    TAG=$ARGS_RELEASE_VERSION
+  else
+    # fetch last tag from git
+    TAG=$(git describe --abbrev=0)
+  fi
+
   if $ARGS_build ; then
-    # build only
+    echo "build only ..."
     echo "dest build dir: $BUILD_DEST_DIR/"
-    build_binaries
+    build_binaries $TAG $BUILD_DEST_DIR
     ls -l $BUILD_DEST_DIR
     exit 0
   elif [[ $ARGS_deploy ]] ; then

deployment.yml

@@ -10,7 +10,7 @@ build:
 releases:
   # to key match the git tag
   v0.6.3-alpha2:
-    name: "docopts binary transitional"
+    name: "docopts binary transitional v0.6.3-alpha2"
     description: |
       This is a transitional release.
 
@@ -29,21 +29,31 @@ releases:
         - added Makefile
         - added build_doc.sh PoC markdown preprocessor
 
-        all examples written for docopts:
-          - shebang conversion `#!/bin/bash` ==> `#!/usr/bin/env bash`
-          - legacy example completed
-          - example from README extracted a file, and merged in README via build_doc.sh
-          - sshdiff full example coded
-          - added examples with `--auto -G`
-
-        docopts.sh helper:
-          - is more documented in the code
-          - as a documenation in docs/README.md
-          - now supports bash strict mode (`set -euo pipefail`)
-          - now supports `--auto -G` to auto parse with global vars (no bash 4 associative array)
-
-        `docopts` behavior sould be unchanged:
-          - add mangled name collision detection
+      all examples written for docopts:
+        - shebang conversion `#!/bin/bash` ==> `#!/usr/bin/env bash`
+        - legacy example completed
+        - example from README extracted a file, and merged in README via build_doc.sh
+        - sshdiff full example coded
+        - added examples with `--auto -G`
+
+      docopts.sh helper:
+        - is more documented in the code
+        - as a documenation in docs/README.md
+        - now supports bash strict mode (`set -euo pipefail`)
+        - now supports `--auto -G` to auto parse with global vars (no bash 4 associative array)
+
+      `docopts` behavior sould be unchanged:
+        - add mangled name collision detection
+
+  v0.6.3-alpha1:
+    name: "docopts for Bash first release in golang"
+    description: |
+      This is a transitional release. It is a complete rewrite of the python's code in go.
+      It supports all the previous API plus some extra command line options.
+
+      Fully compatible with previous 0.6.2 python code for Bash.
+
+      based on https://github.com/docopt/docopts/tree/packaging-debian
 
   v0.6.2:
     name: "first release in Go"

docopts.go

@@ -16,9 +16,9 @@ import (
     "sort"
 )
 
-var Version string = `docopts 0.6.3
+var Version string = `docopts 0.6.3-alpha2
 Copyright (C) 2013 Vladimir Keleshev, Lari Rasku.
-Copyleft (Ɔ) 2018 Sylvain Viart (golang version).
+Copyleft (Ɔ)  2019 Sylvain Viart (golang version).
 License MIT <http://opensource.org/licenses/MIT>.
 This is free software: you are free to change and redistribute it.
 There is NO WARRANTY, to the extent permitted by law.

docs/pre_built_binaries.md

@@ -1,8 +1,10 @@
 # docopts pre-built binaries
 
-`docopts` is a shell helper mainly for bash as now, for parsing arguments using [docopt language](https://docopt.org).
+`docopts` is a shell helper mainly for bash as now, for parsing command-line arguments using the
+[docopt language](https://docopt.org).
 
-This implementation use Go, and we provide pre-built binaries on releases.
+This implementation use Go, and we provide pre-built binaries on available for download from
+github releases.
 
 The sha256sum is provided to ensure the uploaded binaries are conform to the
 one built by the uploader.
@@ -13,8 +15,8 @@ You can simply download the one you want from
 [releases](https://github.com/docopt/docopts/releases).
 
 Or we provide a command line helper if you cloned this repository, that will
-simply download from our repository and provide a `docopts` binary in the
-current folder.
+simply download the good binary format from our repository and provide a `docopts` binary in
+your current folder.
 
 
 ```
@@ -24,7 +26,7 @@ current folder.
 ## Release binaries
 
 This section is for developper. In order to release binaries you will need
-some granted access to github.
+some granted access to github API.
 
 You will also need some more developper tools.
 
@@ -94,20 +96,20 @@ make
 ### deploy
 
 We provide a deploy script, which will take the last git tag, and a deployment
-message configured in a yaml file `deployment.yml`.
+message written in a yaml file `deployment.yml`.
 
 So you need to create the release text in `deployment.yml` before you run
 `deploy.sh`.
 
 See what will going on:
 
 ```
-./deploy.sh -n
+./deploy.sh deploy -n
 ```
 
 Deploy and replace existing binaries for this release.
 
 ```
-./deploy.sh -n
+./deploy.sh deploy --replace
 ```