go-test #584
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
name: go-test | |
# ^^^^^^^ | |
# https://github.com/organization/repository/workflows/go-test/badge.svg | |
# ^^^^^^^ | |
on: | |
push: | |
branches: | |
- main | |
# NO paths-ignore | |
pull_request: | |
# NO paths-ignore | |
workflow_dispatch: | |
inputs: | |
COVER: | |
description: "Run go test with coverage" | |
default: "false" | |
type: choice | |
options: | |
- "true" | |
- "false" | |
schedule: | |
- cron: '0 2 * * *' # NOTE: Run daily at 11:00 JST | |
# NOTE: If commit & push continuously, cancel the workflow other than the latest commit. | |
concurrency: | |
group: ${{ github.workflow }}-${{ github.base_ref }}-${{ github.head_ref }}-${{ github.ref }} | |
cancel-in-progress: true | |
permissions: | |
id-token: write | |
contents: read | |
env: | |
DOCKER_BUILD_CACHE_FROM: /tmp/.docker-build-buildx-cache-from | |
DOCKER_BUILD_CACHE_TO: /tmp/.docker-build-buildx-cache-to | |
WORKDIR: . | |
# COVER: ${{ github.event_name == 'schedule' || github.event.inputs.COVER == 'true' || endsWith(github.event.pull_request.title, '[cover]') }} | |
COVER: true # always run with coverage | |
defaults: | |
run: | |
shell: bash | |
jobs: | |
paths-ignore: | |
runs-on: ubuntu-latest | |
outputs: | |
skip: ${{ steps.paths-ignore.outputs.skip }} | |
steps: | |
- uses: kunitsucom/github-actions-paths-ignore-alternative@v0.0.4 | |
id: paths-ignore | |
with: | |
paths-ignore: |- | |
# substrings of file paths to ignore written in regular expressions | |
^.github/dependabot.yml$ | |
^.github/pull_request_template.md$ | |
^.github/release.yml$ | |
^.github/workflows/label-checker.yml$ | |
^.github/workflows/task-list-checker.yml$ | |
^.*\.md$ | |
^.*\.log$ | |
^CREDITS$ | |
# > Note: A job that is skipped will report its status as "Success". | |
# > It will not prevent a pull request from merging, even if it is a required check. | |
# ref. https://docs.github.com/en/actions/using-jobs/using-conditions-to-control-job-execution#overview | |
go-test: | |
runs-on: ubuntu-latest | |
needs: paths-ignore | |
if: ${{ needs.paths-ignore.outputs.skip != 'true' }} | |
steps: | |
- uses: actions/checkout@v4 | |
- name: DEBUG | |
shell: bash | |
run: | | |
cat <<'DEBUG_DOC' | |
== DEBUG ======================================================= | |
github.ref: ${{ github.ref }} | |
github.event_name: ${{ github.event_name }} | |
-- toJSON(github.event.inputs) --------------------------------- | |
${{ toJSON(github.event.inputs) }} | |
-- toJSON(github) ---------------------------------------------- | |
${{ toJSON(github) }} | |
================================================================ | |
DEBUG_DOC | |
- name: actions/cache for versenv | |
uses: actions/cache@v4 | |
with: | |
path: | | |
~/.cache/versenv | |
key: versenv-${{ runner.os }}-${{ hashFiles('**/.versenv.env') }} | |
restore-keys: | | |
versenv-${{ runner.os }}- | |
- name: Add GITHUB_PATH, GITHUB_ENV | |
shell: bash | |
run: | | |
# Update GITHUB_PATH | |
cat <<GITHUB_PATH >> $GITHUB_PATH | |
${PWD}/.local/bin | |
${PWD}/${{ env.WORKDIR }}/.local/bin | |
${PWD}/.bin | |
GITHUB_PATH | |
# Update GITHUB_ENV | |
grep -Ev '^\s*$|^\s*#' .versenv.env >> $GITHUB_ENV | |
- name: Setup versenv | |
shell: bash | |
run: | | |
# Setup versenv | |
direnv allow ${{ env.WORKDIR }} | |
make versenv | |
- uses: actions/setup-go@v5 # ref. https://github.com/actions/setup-go#usage | |
id: setup-go | |
with: | |
cache: false | |
go-version-file: ${{ env.WORKDIR }}/go.mod | |
- name: Get Golang info | |
id: golang-info | |
shell: bash | |
run: | | |
echo "GOVERSION=$(go version | cut -d' ' -f3)" >> "$GITHUB_OUTPUT" | |
echo "GOCACHE=$(go env GOCACHE)" >> "$GITHUB_OUTPUT" | |
- name: actions/cache for go | |
uses: actions/cache@v4 | |
with: | |
path: | | |
~/go/pkg/mod | |
${{ steps.golang-info.outputs.GOCACHE }} | |
key: ${{ runner.os }}-go-${{ steps.golang-info.outputs.GOVERSION }}-${{ hashFiles('**/go.sum') }}-${{ hashFiles('**/*.go') }} | |
restore-keys: | | |
${{ runner.os }}-go-${{ steps.golang-info.outputs.GOVERSION }}-${{ hashFiles('**/go.sum') }}- | |
${{ runner.os }}-go-${{ steps.golang-info.outputs.GOVERSION }}- | |
${{ runner.os }}-go- | |
# MEMO: Enable docker compose layer cache from here | |
- name: Set up Buildx for docker build cache | |
uses: docker/setup-buildx-action@v3 | |
- name: Use docker build cache | |
uses: actions/cache@v4 | |
with: | |
path: ${{ env.DOCKER_BUILD_CACHE_FROM }} | |
key: docker-build-buildx-${{ github.sha }} | |
restore-keys: | | |
docker-build-buildx- | |
# MEMO: Enable docker compose layer cache until here | |
- name: Run go test | |
env: | |
DEBIAN_FRONTEND: noninteractive | |
# for docker build cache | |
GHA_CACHE_OPTS: --cache-from type=local,src=${{ env.DOCKER_BUILD_CACHE_FROM }} --cache-to type=local,dest=${{ env.DOCKER_BUILD_CACHE_TO }},mode=max | |
# GITHUB_TOKEN: ${{ secrets.GH_BOT_TOKEN }} | |
working-directory: ${{ env.WORKDIR }} | |
shell: bash | |
run: | | |
set -Eeu -o pipefail -x | |
direnv allow . | |
if [ -n "${GITHUB_TOKEN-}" ]; then | |
direnv exec . bash -Eeux -o pipefail -c 'echo "${GOPRIVATE:-}${GOPRIVATE+,}" | while read -d , -r LINE; do echo "set git config: ${LINE}"; git config --global url."https://${GITHUB_TOKEN}:x-oauth-basic@${LINE}".insteadOf "https://${LINE}"; done' | |
fi | |
if [ "${{ env.COVER }}" = "true" ]; then | |
direnv exec . make test-cover | |
else | |
direnv exec . make test | |
fi | |
- uses: codecov/codecov-action@v4 # ref. https://github.com/codecov/codecov-action#example-workflowyml-with-codecov-action | |
if: ${{ env.COVER == 'true' }} | |
with: | |
token: ${{ secrets.CODECOV_TOKEN }} | |
files: ${{ env.WORKDIR }}/coverage.txt | |
- name: Move docker build cache (workaround) | |
if: always() | |
run: | | |
if [[ -d ${{ env.DOCKER_BUILD_CACHE_TO }} ]]; then | |
rm -rf ${{ env.DOCKER_BUILD_CACHE_FROM }} | |
mv ${{ env.DOCKER_BUILD_CACHE_TO }} ${{ env.DOCKER_BUILD_CACHE_FROM }} | |
fi | |
shell: bash |