janus

Janus is a reusable tool for versioning and deploying builds to Google Cloud Provider (GCP) Storage from the CI environment.

Install

Requirements:

• encrypted JSON GCP service account key, with access to GCP Storage feature
• CI environment variable GCP_PASSWD to be set, either via secure global (as below), or via CI GUI interface
• having Janus installed (as below), via curl -sL https://raw.githubusercontent.com/ethereumproject/janus/master/get.sh | bash, and then exporting her to the CI PATH
• in order to verify the janus archive gpg must be available in the system. gpg is standard on Travis.

Usage

Janus has two subcommands: deploy and version.

Deploy

Janus can use an encrypted or decrypted .json GCP service key file. In case of an encrypted JSON key file, Janus will attempt to decrypt it using openssl, and depends on an environment variable GCP_PASSWD to be set. After successfully decrypting the key and deploying the files, Janus will automatically destroy (rm) the decrypted key from the CI.

$ janus deploy -to builds.etcdevteam.com/go-ethereum/v3.5.x/ -files ./dist/*.zip -key gcloud-service-encrypted-or-decrypted.json
> Deploying...

Version

version uses some variant of git describe or git rev-list to produce a version number, as defined by -format

$ janus version -format v%M.%m.%P+%C-%S
> v3.5.0+55-asdf123

-format=value takes the interpolated forms:

%M - major version
%m - minor version
%P - patch version
%C - commit count since last tag
%S - HEAD sha1 (first 7 characters)

So this:

replaces this:

- git describe --tags --always > version.txt
- sed -E 's/v([[:digit:]]+\.[[:digit:]]+)\.[[:digit:]]-([[:digit:]]+)-g([a-f0-9]+)/v\1.\2+\3/' version.txt > version-app.txt
- sed -E 's/v([[:digit:]]+\.[[:digit:]]+)\.[[:digit:]]-([[:digit:]]+).+/v\1.\2/' version.txt > version-only.txt
- sed -E 's/v([[:digit:]]+\.[[:digit:]]+)\.[[:digit:]]-([[:digit:]]+).+/v\1.x/' version.txt > version-base.txt

Example

# .travis.yml
env:
  global:
    # This value should hold at least environment variable GCP_PASSWD=xxx in order to decrypt the GCP service account key that Janus relies on.
    # eg.
    # $ travis encrypt -r ethereumproject/emerald-rs GCP_PASSWD=asdfasdfasdfasdfasdf
    - secure: "MjvfqrKakMa+z+6LFxaL30n+BtjxUm2BnJ6/+S5cbxo"

before_deploy:
  # Install Janus
  - curl -sL https://raw.githubusercontent.com/ethereumproject/janus/master/get.sh | bash

  # Add janus to PATH, this is *required*.
  #   Gotcha: This has to happen outside the 'get' script, otherwise PATH will only be set for
  #   the script subprocess.
  - export PATH=$PATH:$PWD/janusbin

  # Prepare file(s) to deploy.
  - zip emerald-"$TRAVIS_OS_NAME"-$(janus version -format v%M.%m.%P+%C-%S).zip emerald-cli

deploy:
  # Note that it's important to skip cleanup if you want to deploy builds generated during a previous process
  skip_cleanup: true
  provider: script
  # Note that if you want to use a stand-alone script, you can use the follow syntax.
  #   Gotcha: on Travis you *must* use the relative path execution syntax ('./')
  # script: ./deploy.sh
  script:
      # Note that decrypting the GCP service key requires GCP_PASSWD environment variable to be set (see above).
      - janus deploy -to "builds.etcdevteam.com/project/$(janus version -format %M.%m.x)" -files "*.zip-key gcp-key.enc.json
  on:
    branch: master
  tags: true

In ancient Roman religion and myth, Janus (/ˈdʒeɪnəs/; Latin: Iānus, pronounced [ˈjaː.nus]) is the god of beginnings, gates, transitions, time, duality, doorways,[1] passages, and endings.

• https://en.wikipedia.org/wiki/Janus