Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add automated release pipeline #33

Merged
merged 1 commit into from
Mar 10, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
108 changes: 108 additions & 0 deletions .github/workflows/release.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,108 @@
name: 'Release'
on:
push:
# take no actions on push to any branch...
branches-ignore:
- '**'
# ... only act on release tags
tags:
- 'v*'

env:
GO_VERSION: "1.19.x"

jobs:
wait-for-checks:
runs-on: ubuntu-latest
steps:

- uses: actions/checkout@v3

# we don't want to release commits that have been pushed and tagged, but not necessarily merged onto main
- name: Ensure tagged commit is on main
run: |
echo "Tag: ${GITHUB_REF##*/}"
git fetch origin main
git merge-base --is-ancestor ${GITHUB_REF##*/} origin/main && echo "${GITHUB_REF##*/} is a commit on main!"

- name: Build snapshot artifacts
uses: fountainhead/action-wait-for-check@v1.1.0
id: snapshot
with:
token: ${{ secrets.GITHUB_TOKEN }}
# This check name is defined as the github actions job name (in .github/workflows/snapshot.yaml)
checkName: "Build-Snapshot-Artifacts"
ref: ${{ github.event.pull_request.head.sha || github.sha }}

- name: Check static analysis
uses: fountainhead/action-wait-for-check@v1.1.0
id: static-analysis
with:
token: ${{ secrets.GITHUB_TOKEN }}
# This check name is defined as the github actions job name (in .github/workflows/static-analysis.yaml)
checkName: "Static-Analysis (1.19.x, ubuntu-latest)"
ref: ${{ github.event.pull_request.head.sha || github.sha }}

- name: Check unit test results
uses: fountainhead/action-wait-for-check@v1.1.0
id: tests-unit
with:
token: ${{ secrets.GITHUB_TOKEN }}
# This check name is defined as the github actions job name (in .github/workflows/unit-test.yaml)
checkName: "Unit-Tests (1.19.x, ubuntu-latest)"
ref: ${{ github.event.pull_request.head.sha || github.sha }}

- name: Quality gate
if: steps.static-analysis.outputs.conclusion != 'success' || steps.tests-unit.outputs.conclusion != 'success' || steps.snapshot.outputs.conclusion != 'success' || steps.acceptance-helm-1-13-12.outputs.conclusion != 'success' || steps.acceptance-helm-1-18-0.outputs.conclusion != 'success'
run: |
echo "Static-Analysis Status : ${{ steps.static-analysis.outputs.conclusion }}"
echo "Unit Test Status : ${{ steps.tests-unit.outputs.conclusion }}"
echo "Build Snapshot Artifacts Status: ${{ steps.snapshot.outputs.conclusion }}"
false

release:
needs: [ wait-for-checks ]
runs-on: ubuntu-latest
steps:

- uses: actions/setup-go@v2
with:
go-version: ${{ env.GO_VERSION }}

- uses: actions/checkout@v3
with:
fetch-depth: 0

- name: Restore bootstrap cache
id: cache
uses: actions/cache@v2
with:
path: |
~/go/pkg/mod
${{ github.workspace }}/.tmp
key: ${{ runner.os }}-go-${{ env.GO_VERSION }}-${{ hashFiles('Makefile') }}-${{ hashFiles('**/go.sum') }}
restore-keys: |
${{ runner.os }}-go-${{ env.GO_VERSION }}-${{ hashFiles('Makefile') }}-
${{ runner.os }}-go-${{ env.GO_VERSION }}-

- name: Bootstrap dependencies
if: steps.cache.outputs.cache-hit != 'true'
run: make ci-bootstrap

- name: Login to Docker Hub
id: docker-login
run: |
echo "${DOCKER_PASS}" | docker login -u "${DOCKER_USER}" --password-stdin
env:
DOCKER_USER: ${{ secrets.TOOLBOX_DOCKER_USER }}
DOCKER_PASS: ${{ secrets.TOOLBOX_DOCKER_PASS }}

- name: Build snapshot artifacts
run: make release
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

- uses: actions/upload-artifact@v2
with:
name: artifacts
path: dist/**/*
48 changes: 48 additions & 0 deletions .github/workflows/snapshot.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
name: 'Snapshot'
on:
workflow_dispatch:
push:
# ... only act on pushes to main
branches:
- main
# ... do not act on release tags
tags-ignore:
- v*

env:
GO_VERSION: "1.19.x"

jobs:
Build-Snapshot-Artifacts:
runs-on: ubuntu-latest
steps:

- uses: actions/setup-go@v2
with:
go-version: ${{ env.GO_VERSION }}

- uses: actions/checkout@v3

- name: Restore bootstrap cache
id: cache
uses: actions/cache@v2
with:
path: |
~/go/pkg/mod
${{ github.workspace }}/.tmp
key: ${{ runner.os }}-go-${{ env.GO_VERSION }}-${{ hashFiles('**/go.sum') }}-${{ hashFiles('Makefile') }}
restore-keys: |
${{ runner.os }}-go-${{ env.GO_VERSION }}-${{ hashFiles('**/go.sum') }}-
${{ runner.os }}-go-${{ env.GO_VERSION }}-

- name: Bootstrap dependencies
if: steps.cache.outputs.cache-hit != 'true'
run: make ci-bootstrap

- name: Build snapshot artifacts
run: make snapshot

- uses: actions/upload-artifact@v2
with:
name: artifacts
path: snapshot/**/*
4 changes: 2 additions & 2 deletions .github/workflows/static-analysis.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,11 @@ jobs:
platform: [ubuntu-latest]
runs-on: ${{ matrix.platform }}
steps:
- uses: actions/setup-go@v2
- uses: actions/setup-go@v3
with:
go-version: ${{ matrix.go-version }}

- uses: actions/checkout@v2
- uses: actions/checkout@v3

- name: Restore bootstrap cache
id: bootstrap-cache
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/unit-test.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ jobs:
with:
go-version: ${{ matrix.go-version }}

- uses: actions/checkout@v2
- uses: actions/checkout@v3

- name: Restore bootstrap cache
id: bootstrap-cache
Expand Down
16 changes: 16 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ SUCCESS := $(BOLD)$(GREEN)
# ci dependency versions
GOLANG_CI_VERSION = v1.50.1
GOSIMPORTS_VERSION = v0.3.4
GORELEASER_VERSION = v1.16.0

## Build variables
ifeq "$(strip $(VERSION))" ""
Expand Down Expand Up @@ -57,10 +58,15 @@ bootstrap-tools: $(TEMPDIR)
$(call title,Boostrapping tools)
curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s -- -b $(TEMPDIR)/ $(GOLANG_CI_VERSION)
GOBIN="$(realpath $(TEMPDIR))" go install github.com/rinchsan/gosimports/cmd/gosimports@$(GOSIMPORTS_VERSION)
GOBIN="$(abspath $(TEMPDIR))" go install github.com/goreleaser/goreleaser@$(GORELEASER_VERSION)

.PHONY: bootstrap
bootstrap: bootstrap-go bootstrap-tools ## Download and install all go dependencies (+ prep tooling in the ./tmp dir)

.PHONY: ci-bootstrap
ci-bootstrap: bootstrap
sudo apt update && sudo apt install -y bc jq

.PHONY: static-analysis
static-analysis: lint

Expand Down Expand Up @@ -95,3 +101,13 @@ unit: ## Run unit tests (with coverage)
@go tool cover -func $(COVER_REPORT) | grep total | awk '{print substr($$3, 1, length($$3)-1)}' > $(COVER_TOTAL)
@echo "Coverage: $$(cat $(COVER_TOTAL))"
@if [ $$(echo "$$(cat $(COVER_TOTAL)) >= $(COVERAGE_THRESHOLD)" | bc -l) -ne 1 ]; then echo "$(RED)$(BOLD)Failed coverage quality gate (> $(COVERAGE_THRESHOLD)%)$(RESET)" && false; fi

.PHONY: snapshot
snapshot: ## Build a snapshot binaries and docker images
$(call title,Building snapshot binary)
$(TEMPDIR)/goreleaser release --skip-publish --clean --snapshot --config .goreleaser.yaml

.PHONY: release
release: ## Publish release binaries and docker images
$(call title, release binary)
$(TEMPDIR)/goreleaser release --clean --config .goreleaser.yaml