Drafting deploy.sh most code OK. #32

adding v0.6.2 missing tag, not yet supported by deploy.sh

deploy.sh now support build target to only build for target
listed in deployment.yml

uploading doesn't delete assets, tested on Sylvain303

docs/pre_built_binaries.md is not uptodate

Author: Sylvain Viart

.gitignore

@@ -1,3 +1,4 @@
 docopts
 docopts-*
 *.swp
+env

Makefile

@@ -1,5 +1,8 @@
+#
+# Makefile for managing docopts build
+#
+# See also: deploy.sh
 
-DOCOPT_GO=${GOPATH}/linux_amd64/github.com/docopt/docopt-go.a
 
 PREFIX ?= /usr/local
 
@@ -25,6 +28,7 @@ docopts-OSX: docopts.go
 docopts-arm: docopts.go
 	env GOOS=linux GOARCH=arm go build -o docopts-arm docopts.go
 
+# requires write access to $PREFIX
 install: all
 	cp docopts docopts.sh $(PREFIX)/bin
 
@@ -40,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
+	rm -f docopts-* docopts README.tmp build/docopts_*

build/.placeholder

@@ -0,0 +1 @@
+build directory

deploy.sh

@@ -1,11 +1,28 @@
 #!/usr/bin/env bash
-#export GITHUB_TOKEN=...
+#
+# Tools for deploying our release to github
+#
+# Usage: ./deploy.sh deploy [-n] [-r REMOTE_REPOS] [RELEASE_VERSION]
+#        ./deploy.sh build
+#
+# Options:
+#   -n                   Dry run, show with version, files and description
+#   -r REMOTE_REPOS      Specify a REMOTE_REPOS name [default: origin]
+#
+# Arguments:
+#   RELEASE_VERSION      a git tag
+#
+# Actions:
+#   build  only build using gox and deployment.yml config
+#
+# deploy.sh read description in deployment.yml
 
-set -euo pipefail
 
+DEPLOYMENT_FILE=deployment.yml
 GITHUB_USER=sylvain303
 GITHUB_REPO=docopts
 TAG="v0.6.3-alpha2"
+BUILD_DEST_DIR=build
 
 create_release()
 {
@@ -18,13 +35,22 @@ create_release()
       --pre-release
 }
 
+prepare_upload()
+{
+  local build_dest_dir=$1
+  pushd $build_dest_dir > /dev/null
+  rm -f sha256sum.txt
+  sha256sum * > sha256sum.txt
+  popd > /dev/null
+  find $build_dest_dir -type f -a ! -name .\*
+}
+
 upload_binaries()
 {
   local filenames=$*
-  sha256sum $filenames > sha256sum.txt
 
   local f
-  for f in $filenames sha256sum.txt
+  for f in $filenames
   do
     echo "uploading '$f' ..."
     gothub upload \
@@ -37,4 +63,108 @@ upload_binaries()
   done
 }
 
-upload_binaries docopts docopts-32bits docopts-OSX
+indent()
+{
+  local arg="$1"
+  if [[ -f "$arg" ]] ; then
+    sed -e 's/^/  /' "$arg"
+  else
+    sed -e 's/^/  /' <<< "$arg"
+  fi
+}
+
+get_arch_build_target()
+{
+  local arch_list=$(yq.v2 r $DEPLOYMENT_FILE build | sed -e 's/^- //')
+  if [[ $# -eq 1 && $1 == 'gox' ]] ; then
+    # join output and trim
+    tr $'\n' ' ' <<< "$arch_list" | sed -e 's/ $//'
+  else
+    echo "$arch_list"
+  fi
+}
+
+build_binaries()
+{
+  gox -osarch "$(get_arch_build_target gox)" -output="$BUILD_DEST_DIR/{{.Dir}}_{{.OS}}_{{.Arch}}"
+}
+
+yaml_keys ()
+{
+  yq.v2 r "$1" "$2" | sed -n -e '/^\([^ ]\([^:]\+\)\?\):/  s/:.*// p'
+}
+
+main_deploy()
+{
+  # 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
+
+  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)
+
+  if $ARGS_n ; then
+    cat << EOT
+GITHUB_TOKEN: $GITHUB_TOKEN
+build_dir: $BUILD_DEST_DIR
+repository: $repository
+tag: $TAG
+files: $UPLOAD_FILES
+sha256sum.txt:
+$(indent $BUILD_DEST_DIR/sha256sum.txt)
+description:
+$(indent "$description")
+EOT
+    exit 0
+  else
+    if [[ -z $GITHUB_TOKEN ]] ; then
+      echo "GITHUB_TOKEN must be exported"
+      return 1
+    fi
+    upload_binaries $UPLOAD_FILES
+  fi
+}
+
+if [[ $0 == $BASH_SOURCE ]] ; then
+  # bash strict mode
+  set -euo pipefail
+
+  # we add our repository path to run our local docopts binary
+  # you will have to build it first of course.
+  PATH=$(dirname $0):$PATH
+  source docopts.sh --auto -G "$@"
+  # fix docopt bug https://github.com/docopt/docopt/issues/386
+  ARGS_REMOTE_REPOS=${ARGS_REMOTE_REPOS:-$ARGS_r}
+
+  docopt_print_ARGS -G
+
+  if $ARGS_build ; then
+    # build only
+    echo "dest build dir: $BUILD_DEST_DIR/"
+    build_binaries
+    ls -l $BUILD_DEST_DIR
+    exit 0
+  elif [[ $ARGS_deploy ]] ; then
+     main_deploy
+  else
+    echo "no command found: $*"
+    exit 1
+  fi
+fi

deployment.yml

@@ -1,10 +1,18 @@
 ---
+build:
+  - darwin/386
+  - darwin/amd64
+  - linux/386
+  - linux/amd64
+  - linux/arm
+  # doesn't compile
+  #- android/arm
 releases:
   # to key match the git tag
   v0.6.3-alpha2:
     name: "docopts binary transitional"
     description: |
-      This is a transitional release. 
+      This is a transitional release.
 
       It supports all the previous API plus some extra command line options.
       Fully compatible with previous 0.6.2 python code for Bash.
@@ -37,3 +45,19 @@ releases:
         `docopts` behavior sould be unchanged:
           - add mangled name collision detection
 
+  v0.6.2:
+    name: "first release in Go"
+    description: |
+      This is a transitional release.
+
+      Dopopt for shell.
+
+      It supports all the previous API.
+      Fully compatible with previous 0.6.1 python code for Bash.
+      See: https://github.com/docopt/docopts/tree/v0.6.1%2Bfix
+
+      based on master branch
+
+      changes:
+        - now written in Go, no more python dependancies
+      

docs/pre_built_binaries.md

@@ -24,14 +24,14 @@ current folder.
 ## Release binaries
 
 This section is for developper. In order to release binaries you will need
-some granted access to github, and to more tools.
+some granted access to github.
+
+You will also need some more developper tools.
 
 Most of the tools require a working [Go developper
-environment](https://golang.org/doc/code.html#Organization). Which should be not too
+environment](https://golang.org/doc/code.html#Organization). Which should not be too
 complicated to setup.
 
-You will also need some more developper tools.
-
 Go for it:
 
 ### gox
@@ -58,7 +58,7 @@ https://help.github.com/articles/creating-an-access-token-for-command-line-use
 
 The token needs to have `repos` auth priviledges.
 
-then export it as a bash environment variable
+then export it as a bash environment variable:
 
 ```
 export GITHUB_TOKEN="you token here"
@@ -77,7 +77,7 @@ git push origin v0.6.3-alpha2
 
 See: http://mikefarah.github.io/yq/
 
-For extracting yaml data from deployment.yml
+For extracting yaml data from `deployment.yml`
 
 ```
 go get gopkg.in/mikefarah/yq.v2