clarify README usage examples #126
Workflow file for this run
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: CI/CD | |
on: [push, pull_request] | |
jobs: | |
build-snapshot: | |
runs-on: ubuntu-latest | |
steps: | |
- uses: actions/checkout@v4 | |
- name: Set up Go | |
uses: actions/setup-go@v5 | |
with: | |
go-version-file: go.mod | |
# While not actually (currently) used in snapshot-building, logging in to | |
# DockerHub on non-main builds vets DockerHub login problems in advance of | |
# a merge to main. | |
- name: Log in to Docker Hub | |
uses: docker/login-action@v3 | |
with: | |
username: clapclapexcitement | |
password: ${{ secrets.DOCKERHUB_TOKEN }} | |
- name: Build | |
run: make | |
- name: Ensure unique version | |
run: make check-tag | |
build-and-publish-release: | |
if: github.ref == 'refs/heads/main' | |
runs-on: ubuntu-latest | |
needs: build-snapshot | |
environment: | |
name: release | |
steps: | |
- uses: actions/checkout@v4 | |
- name: Set up Go | |
uses: actions/setup-go@v5 | |
with: | |
go-version-file: go.mod | |
- name: Log in to Docker Hub | |
uses: docker/login-action@v3 | |
with: | |
username: clapclapexcitement | |
password: ${{ secrets.DOCKERHUB_TOKEN }} | |
- name: Create release tag | |
run: make tag | |
env: | |
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
- name: Build & Release | |
run: make release | |
env: | |
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} |