Boilerplate update (flyteorg#193)

Makefile

@@ -1,7 +1,7 @@
 export REPOSITORY=flyteadmin
-include boilerplate/lyft/docker_build/Makefile
-include boilerplate/lyft/golang_test_targets/Makefile
-include boilerplate/lyft/end2end/Makefile
+include boilerplate/flyte/docker_build/Makefile
+include boilerplate/flyte/golang_test_targets/Makefile
+include boilerplate/flyte/end2end/Makefile
 
 GIT_VERSION := $(shell git describe --always --tags)
 GIT_HASH := $(shell git rev-parse --short HEAD)
@@ -12,6 +12,7 @@ LD_FLAGS="-s -w -X $(PACKAGE)/version.Version=$(GIT_VERSION) -X $(PACKAGE)/versi
 
 .PHONY: update_boilerplate
 update_boilerplate:
+	@curl https://raw.githubusercontent.com/flyteorg/boilerplate/master/boilerplate/update.sh -o boilerplate/update.sh
 	@boilerplate/update.sh
 
 .PHONY: integration

boilerplate/flyte/docker_build/Makefile

@@ -0,0 +1,12 @@
+# WARNING: THIS FILE IS MANAGED IN THE 'BOILERPLATE' REPO AND COPIED TO OTHER REPOSITORIES.
+# ONLY EDIT THIS FILE FROM WITHIN THE 'FLYTEORG/BOILERPLATE' REPOSITORY:
+# 
+# TO OPT OUT OF UPDATES, SEE https://github.com/flyteorg/boilerplate/blob/master/Readme.rst
+
+.PHONY: docker_build
+docker_build:
+	IMAGE_NAME=$$REPOSITORY ./boilerplate/flyte/docker_build/docker_build.sh
+
+.PHONY: dockerhub_push
+dockerhub_push:
+	IMAGE_NAME=flyteorg/$$REPOSITORY REGISTRY=docker.io ./boilerplate/flyte/docker_build/docker_build.sh

boilerplate/lyft/docker_build/Readme.rst → boilerplate/flyte/docker_build/Readme.rst

@@ -11,13 +11,13 @@ If git head has a git tag, the Dockerhub image will also be tagged ``<IMAGE>:<GI
 
 **To Enable:**
 
-Add ``lyft/docker_build`` to your ``boilerplate/update.cfg`` file.
+Add ``flyteorg/docker_build`` to your ``boilerplate/update.cfg`` file.
 
-Add ``include boilerplate/lyft/docker_build/Makefile`` in your main ``Makefile`` _after_ your REPOSITORY environment variable
+Add ``include boilerplate/flyte/docker_build/Makefile`` in your main ``Makefile`` _after_ your REPOSITORY environment variable
 
 ::
 
     REPOSITORY=<myreponame>
-    include boilerplate/lyft/docker_build/Makefile
+    include boilerplate/flyte/docker_build/Makefile
 
 (this ensures the extra Make targets get included in your main Makefile)

boilerplate/lyft/docker_build/docker_build.sh → boilerplate/flyte/docker_build/docker_build.sh

@@ -1,9 +1,9 @@
 #!/usr/bin/env bash
 
 # WARNING: THIS FILE IS MANAGED IN THE 'BOILERPLATE' REPO AND COPIED TO OTHER REPOSITORIES.
-# ONLY EDIT THIS FILE FROM WITHIN THE 'LYFT/BOILERPLATE' REPOSITORY:
+# ONLY EDIT THIS FILE FROM WITHIN THE 'FLYTEORG/BOILERPLATE' REPOSITORY:
 # 
-# TO OPT OUT OF UPDATES, SEE https://github.com/lyft/boilerplate/blob/master/Readme.rst
+# TO OPT OUT OF UPDATES, SEE https://github.com/flyteorg/boilerplate/blob/master/Readme.rst
 
 set -e
 

boilerplate/flyte/end2end/Makefile

@@ -0,0 +1,8 @@
+# WARNING: THIS FILE IS MANAGED IN THE 'BOILERPLATE' REPO AND COPIED TO OTHER REPOSITORIES.
+# ONLY EDIT THIS FILE FROM WITHIN THE 'FLYTEORG/BOILERPLATE' REPOSITORY:
+#
+# TO OPT OUT OF UPDATES, SEE https://github.com/flyteorg/boilerplate/blob/master/Readme.rst
+
+.PHONY: end2end_execute
+end2end_execute:
+	./boilerplate/flyte/end2end/end2end.sh

boilerplate/lyft/end2end/end2end.sh → boilerplate/flyte/end2end/end2end.sh

@@ -1,9 +1,9 @@
 #!/usr/bin/env bash
 
 # WARNING: THIS FILE IS MANAGED IN THE 'BOILERPLATE' REPO AND COPIED TO OTHER REPOSITORIES.
-# ONLY EDIT THIS FILE FROM WITHIN THE 'LYFT/BOILERPLATE' REPOSITORY:
+# ONLY EDIT THIS FILE FROM WITHIN THE 'FLYTEORG/BOILERPLATE' REPOSITORY:
 #
-# TO OPT OUT OF UPDATES, SEE https://github.com/lyft/boilerplate/blob/master/Readme.rst
+# TO OPT OUT OF UPDATES, SEE https://github.com/flyteorg/boilerplate/blob/master/Readme.rst
 
 set -e
 
@@ -31,4 +31,4 @@ fi
 
 make kustomize
 make end2end_execute
-popd
+popd

boilerplate/flyte/flyte_golang_compile/Readme.rst

@@ -0,0 +1,16 @@
+Flyte Golang Compile
+~~~~~~~~~~~~~~~~~~~~
+
+Common compile script for Flyte golang services.
+
+**To Enable:**
+
+Add ``flyteorg/flyte_golang_compile`` to your ``boilerplate/update.cfg`` file.
+
+Add the following to your Makefile
+
+::
+
+  .PHONY: compile_linux
+  compile_linux:
+    PACKAGES={{ *your packages }} OUTPUT={{ /path/to/output }} ./boilerplate/flyte/flyte_golang_compile.sh

boilerplate/flyte/flyte_golang_compile/flyte_golang_compile.Template

@@ -0,0 +1,26 @@
+# WARNING: THIS FILE IS MANAGED IN THE 'BOILERPLATE' REPO AND COPIED TO OTHER REPOSITORIES.
+# ONLY EDIT THIS FILE FROM WITHIN THE 'FLYTEORG/BOILERPLATE' REPOSITORY:
+# 
+# TO OPT OUT OF UPDATES, SEE https://github.com/flyteorg/boilerplate/blob/master/Readme.rst
+
+if [ -z "$PACKAGES" ]; then
+  echo "PACKAGES environment VAR not set"
+  exit 1
+fi
+
+if [ -z "$OUTPUT" ]; then
+  echo "OUTPUT environment VAR not set"
+  exit 1
+fi
+
+# get the GIT_SHA and RELEASE_SEMVER
+
+GIT_SHA=$(git rev-parse HEAD)
+RELEASE_SEMVER=$(git describe --tags --exact-match $GIT_SHA 2>/dev/null)
+
+CURRENT_PKG=github.com/flyteorg/{{ REPOSITORY }}
+VERSION_PKG="${CURRENT_PKG}/vendor/github.com/flyteorg/flytestdlib"
+
+LDFLAGS="-X ${VERSION_PKG}/version.Build=${GIT_SHA} -X ${VERSION_PKG}/version.Version=${RELEASE_SEMVER}"
+
+GOOS=linux GOARCH=amd64 CGO_ENABLED=0 go build -ldflags "$LDFLAGS" -o "$OUTPUT" "$PACKAGES"

boilerplate/flyte/flyte_golang_compile/update.sh

@@ -0,0 +1,13 @@
+#!/usr/bin/env bash
+
+# WARNING: THIS FILE IS MANAGED IN THE 'BOILERPLATE' REPO AND COPIED TO OTHER REPOSITORIES.
+# ONLY EDIT THIS FILE FROM WITHIN THE 'FLYTEORG/BOILERPLATE' REPOSITORY:
+# 
+# TO OPT OUT OF UPDATES, SEE https://github.com/flyteorg/boilerplate/blob/master/Readme.rst
+
+set -e
+
+DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" >/dev/null && pwd )"
+
+echo "     - generating ${DIR}/flyte_golang_compile.sh"
+sed -e "s/{{REPOSITORY}}/${REPOSITORY}/g" ${DIR}/flyte_golang_compile.Template > ${DIR}/flyte_golang_compile.sh

boilerplate/flyte/github_workflows/Readme.rst

@@ -0,0 +1,22 @@
+Golang Github Actions
+~~~~~~~~~~~~~~~~~
+
+Provides a two github actions workflows.
+
+**To Enable:**
+
+Add ``flyteorg/github_workflows`` to your ``boilerplate/update.cfg`` file.
+
+Add a github secret ``package_name`` with the name to use for publishing (e.g. ``flytepropeller``). Typicaly, this will be the same name as the repository.
+
+*Note*: If you are working on a fork, include that prefix in your package name (``myfork/flytepropeller``).
+
+The actions will push to 2 repos:
+
+	1. ``docker.pkg.github.com/flyteorg/<repo>/<package_name>``
+	2. ``docker.pkg.github.com/flyteorg/<repo>/<package_name>-stages`` : this repo is used to cache build stages to speed up iterative builds after.
+
+There are two workflows that get deployed:
+
+	1. A workflow that runs on Pull Requests to build and push images to github registy tagged with the commit sha.
+	2. A workflow that runs on master merges that bump the patch version of release tag, builds and pushes images to github registry tagged with the version, commit sha as well as "latest"

boilerplate/flyte/github_workflows/master.yml

@@ -0,0 +1,31 @@
+name: Master
+
+on:
+  push:
+    branches:
+      - master
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@master
+        with:
+          fetch-depth: '0'
+      - name: Bump version and push tag
+        id: bump-version
+        uses: anothrNick/github-tag-action@1.17.2
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          WITH_V: true
+          DEFAULT_BUMP: patch
+      - name: Push Docker Image to Github Registry
+        uses: whoan/docker-build-with-cache-action@v5
+        with:
+          username: "${{ github.actor }}"
+          password: "${{ secrets.GITHUB_TOKEN }}"
+          image_name: ${{ secrets.package_name }}
+          image_tag: latest,${{ github.sha }},${{ steps.bump-version.outputs.tag }}
+          push_git_tag: true
+          registry: docker.pkg.github.com
+          build_extra_args: "--compress=true"

boilerplate/flyte/github_workflows/pull_request.yml

@@ -0,0 +1,19 @@
+name: Pull Request
+
+on:
+  pull_request
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v1
+      - name: Push Docker Image to Github Registry
+        uses: whoan/docker-build-with-cache-action@v5
+        with:
+          username: "${{ github.actor }}"
+          password: "${{ secrets.GITHUB_TOKEN }}"
+          image_name: ${{ secrets.package_name }}
+          image_tag: ${{ github.sha }}
+          push_git_tag: true
+          registry: docker.pkg.github.com

boilerplate/lyft/github_workflows/update.sh → boilerplate/flyte/github_workflows/update.sh

@@ -1,9 +1,9 @@
 #!/usr/bin/env bash
 
 # WARNING: THIS FILE IS MANAGED IN THE 'BOILERPLATE' REPO AND COPIED TO OTHER REPOSITORIES.
-# ONLY EDIT THIS FILE FROM WITHIN THE 'LYFT/BOILERPLATE' REPOSITORY:
+# ONLY EDIT THIS FILE FROM WITHIN THE 'FLYTEORG/BOILERPLATE' REPOSITORY:
 #
-# TO OPT OUT OF UPDATES, SEE https://github.com/lyft/boilerplate/blob/master/Readme.rst
+# TO OPT OUT OF UPDATES, SEE https://github.com/flyteorg/boilerplate/blob/master/Readme.rst
 
 set -e
 

boilerplate/lyft/golang_dockerfile/Dockerfile.GoTemplate → boilerplate/flyte/golang_dockerfile/Dockerfile.GoTemplate

@@ -1,20 +1,20 @@
 # WARNING: THIS FILE IS MANAGED IN THE 'BOILERPLATE' REPO AND COPIED TO OTHER REPOSITORIES.
-# ONLY EDIT THIS FILE FROM WITHIN THE 'LYFT/BOILERPLATE' REPOSITORY:
+# ONLY EDIT THIS FILE FROM WITHIN THE 'FLYTEORG/BOILERPLATE' REPOSITORY:
 # 
-# TO OPT OUT OF UPDATES, SEE https://github.com/lyft/boilerplate/blob/master/Readme.rst
+# TO OPT OUT OF UPDATES, SEE https://github.com/flyteorg/boilerplate/blob/master/Readme.rst
 
 FROM golang:1.13.3-alpine3.10 as builder
 RUN apk add git openssh-client make curl
 
 # COPY only the go mod files for efficient caching
-COPY go.mod go.sum /go/src/github.com/lyft/{{REPOSITORY}}/
-WORKDIR /go/src/github.com/lyft/{{REPOSITORY}}
+COPY go.mod go.sum /go/src/github.com/flyteorg/{{REPOSITORY}}/
+WORKDIR /go/src/github.com/flyteorg/{{REPOSITORY}}
 
 # Pull dependencies
 RUN go mod download
 
 # COPY the rest of the source code
-COPY . /go/src/github.com/lyft/{{REPOSITORY}}/
+COPY . /go/src/github.com/flyteorg/{{REPOSITORY}}/
 
 # This 'linux_compile' target should compile binaries to the /artifacts directory
 # The main entrypoint should be compiled to /artifacts/{{REPOSITORY}}

boilerplate/lyft/golang_dockerfile/Readme.rst → boilerplate/flyte/golang_dockerfile/Readme.rst

@@ -5,7 +5,7 @@ Provides a Dockerfile that produces a small image.
 
 **To Enable:**
 
-Add ``lyft/golang_dockerfile`` to your ``boilerplate/update.cfg`` file.
+Add ``flyteorg/golang_dockerfile`` to your ``boilerplate/update.cfg`` file.
 
 Create and configure a ``make linux_compile`` target that compiles your go binaries to the ``/artifacts`` directory ::
 

boilerplate/lyft/golang_dockerfile/update.sh → boilerplate/flyte/golang_dockerfile/update.sh

@@ -1,9 +1,9 @@
 #!/usr/bin/env bash
 
 # WARNING: THIS FILE IS MANAGED IN THE 'BOILERPLATE' REPO AND COPIED TO OTHER REPOSITORIES.
-# ONLY EDIT THIS FILE FROM WITHIN THE 'LYFT/BOILERPLATE' REPOSITORY:
+# ONLY EDIT THIS FILE FROM WITHIN THE 'FLYTEORG/BOILERPLATE' REPOSITORY:
 # 
-# TO OPT OUT OF UPDATES, SEE https://github.com/lyft/boilerplate/blob/master/Readme.rst
+# TO OPT OUT OF UPDATES, SEE https://github.com/flyteorg/boilerplate/blob/master/Readme.rst
 
 set -e
 

boilerplate/lyft/golang_support_tools/go.mod → boilerplate/flyte/golang_support_tools/go.mod

@@ -1,14 +1,12 @@
 module github.com/flyteorg/boilerplate
 
-go 1.13
+go 1.16
 
 require (
 	github.com/alvaroloes/enumer v1.1.2
-	github.com/flyteorg/flytestdlib v0.3.13
+	github.com/flyteorg/flytestdlib v0.3.22
 	github.com/golangci/golangci-lint v1.38.0
-	github.com/pascaldekloe/name v1.0.1 // indirect
 	github.com/vektra/mockery v0.0.0-20181123154057-e78b021dcbb5
-	golang.org/x/sys v0.0.0-20210309074719-68d13333faf2 // indirect
 )
 
 replace github.com/vektra/mockery => github.com/enghabu/mockery v0.0.0-20191009061720-9d0c8670c2f0