pre_built_binaries.md

docopts pre-built binaries

docopts is a shell helper mainly for bash as now, for parsing command-line arguments using the docopt language.

This implementation use Go, and we provide pre-built binaries available for download from github releases.

The sha256sum is provided to ensure the uploaded binaries are conform to the one built by the uploader.

get the binary

You can simply download the one you want from releases.

Or we provide a command line helper if you cloned this repository, that will simply download the good binary format from our repository and provide a docopts binary in your current folder.

./get_docopts.sh

Release binaries

This section is for developper. In order to release binaries you will need some granted access to github API.

You will also need some more developper tools.

Most of the tools require a working Go developper environment. Which should not be too complicated to setup.

All dependancies are installed in your Go workspace with:

make install_builddep

Go for it:

gox

We provide binaries cross-compiled from GNU/Linux using gox

go get github.com/mitchellh/gox

govvv

Get version information to be embedded in binary at compile time

go get github.com/ahmetb/govvv

github release uploader

We publish release using a command line tools and using github API gothub

go get github.com/itchio/gothub

github API token

You will need a valid gitub token for the target repository.

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:

export GITHUB_TOKEN="you token here"

git tag a new release

We use semantic verion tags

Our version is stored in VERSION file to be used by govvv.

echo "v0.6.3-alpha2" > VERSION
git tag -a "$(cat VERSION)" -m "golang 2019"
git push origin "$(cat VERSION)"

yaml command-line tool

See: http://mikefarah.github.io/yq/

For extracting yaml data from deployment.yml

go get gopkg.in/mikefarah/yq.v2

deploy / publish release

We provide a deploy script, which will take the last git tag, and a deployment message written in a yaml file deployment.yml.

The script can be downloaded from https://github.com/opensource-expert/deploy.sh

install deploy.sh

deploy.sh uses docopts for parsing our command line option. So you will need to build a first docopts and having it installed in th PATH

build docopts:

cd path/to/docopt/docopts
make

clone and install deploy.sh (will be installed by default in PREFIX=${HOME}/.local

git clone https://github.com/opensource-expert/deploy.sh deploy_sh
cd deploy_sh
make
make install

if your ${HOME}/.local/bin is not in your PATH

PATH=$PATH:${HOME}/.local/bin

test

deploy.sh -h

deployment steps

In docopts project folder.

So you need to create the release text in deployment.yml before you run deploy.sh.

See what will going on (dry-run):

deploy.sh deploy -n

Deploy and replace existing binaries for this release.

deploy.sh deploy --replace

Only build binaries in build/ dir:

deploy.sh build