gofer

README

Gofer

A CLI and notifier utilities to help you keep your project's ever-changing dependency versions up to date.

The Name

According to the dictionary: gofer - an employee whose duties include running errands

The tool is also written in Go, a language with a recognizable gopher mascot

Motivation

The process of checking for new docker image versions and Github project releases is pretty time consuming. The idea for a tool that would automate that process was born.

Supported Dependencies

• docker - depending on the implementation of the registry the mechanism to provide the credentials will be different
  • dockerhub
  • gcr.io
  • quay.io
  • private registry - (in progress)
• github
• manual - the dig command will skip this dependency when fetching latest version

CLI Tool

Prerequisites

Using a Docker container

• docker installed
• if desired add command to your path:

echo 'docker run                                    \
  -v $(pwd):/gofer                                  \
  -e GOOGLE_ACCESS_TOKEN=$GOOGLE_ACCESS_TOKEN       \
  dkoshkin/gofer:stable $@ ' > /usr/local/bin/gofer \
&& chmod +x /usr/local/bin/gofer

Using a binary

• a Linux or macOS

# for Linux
wget https://github.com/dkoshkin/gofer/releases/download/$VERSION/gofer-linux-amd64 -O /usr/local/bin/gofer
# for macOS
wget https://github.com/dkoshkin/gofer/releases/download/$VERSION/gofer-darwin-amd64 -O /usr/local/bin/gofer

Usage

1. Initialize an empty config file in ./.gofer/config.yaml

gofer init -f ./.gofer/config.yaml

Will result in ./.gofer/config.yaml:

apiversion: v0.1
dependencies: []

---

1. Add some dependencies with an optional --mask (a regular expression) and --type.
   The --type will be inferred from the name but can be set explicitly or set to manual to for unsupported dependencies.
   Note when set to manual the dig command will skip the dependency when fetching latest version.

gofer add busybox 1.28.1 --mask "1.28.[0-9]+" --type docker

gofer add "https://github.com/kubernetes/kubernetes" v1.17.5 --mask "v1.17.[0-9]+" --type github

Will result in ./.gofer/config.yaml:

apiversion: v0.1
dependencies:
- name: busybox
  type: docker
  version: 1.28.1
  mask: 1.28.[0-9]+
- name: https://github.com/kubernetes/kubernetes
  type: github
  version: v1.17.5
  mask: v1.17.[0-9]+

IMPORTANT when fetching versions for gcr.io docker images set:

export GOOGLE_ACCESS_TOKEN=`gcloud auth print-access-token`

IMPORTANT when fetching versions for private github repos or when the unauthenticated rate limit of 60/hour is not sufficient set a personal access token:

export GITHUB_ACCESS_TOKEN=$SOME_TOKEN

---

1. Fetch the latest versions of all dependencies

gofer dig

Will result in ./.gofer/config.yaml:

apiversion: v0.1
dependencies:
- name: busybox
  type: docker
  version: 1.28.1
  latestVersion: 1.28.4
  mask: 1.28.[0-9]+
- name: https://github.com/kubernetes/kubernetes
  type: github
  version: v1.17.5
  latestVersion: v1.17.6
  mask: v1.17.[0-9]+

Example

A more complete config.yaml example available here.

Development

make test
# build docker container
make build-cli-image
# or build a binary to bin/
make build-cli-binary

Notifier

Development

make test
# build docker container
make build-notifier-image
# or build a binary to bin/
make build-notifier-binary