Release workflow #6
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
| # Copyright 2023 Democratized Data Foundation | |
| # | |
| # Use of this software is governed by the Business Source License | |
| # included in the file licenses/BSL.txt. | |
| # | |
| # As of the Change Date specified in that file, in accordance with | |
| # the Business Source License, use of this software will be governed | |
| # by the Apache License, Version 2.0, included in the file | |
| # licenses/APL.txt. | |
| name: Release workflow | |
| on: | |
| workflow_dispatch: | |
| inputs: | |
| tag: | |
| description: 'New tag name' | |
| required: true | |
| permissions: | |
| contents: write | |
| packages: write | |
| issues: write | |
| jobs: | |
| prepare: | |
| strategy: | |
| matrix: | |
| os: [ubuntu-latest, macos-latest, windows-latest] | |
| runs-on: ${{ matrix.os }} | |
| steps: | |
| - name: Checkout code into the directory | |
| uses: actions/checkout@v3 | |
| with: | |
| fetch-depth: 0 | |
| - name: Setup Go environment explicitly | |
| uses: actions/setup-go@v3 | |
| with: | |
| go-version: "1.21" | |
| check-latest: true | |
| cache: true | |
| - name: Apply tag | |
| run: git tag ${{ github.event.inputs.tag }} | |
| - name: Build modules | |
| run: make deps:modules | |
| - name: Set up QEMU | |
| if: matrix.os == 'ubuntu-latest' | |
| uses: docker/setup-qemu-action@v2 | |
| - name: Log in to Docker Hub | |
| if: matrix.os == 'ubuntu-latest' | |
| uses: docker/login-action@v2 | |
| with: | |
| username: ${{ secrets.DOCKER_USERNAME }} | |
| password: ${{ secrets.DOCKER_PASSWORD }} | |
| - name: Log in to the Container registry | |
| if: matrix.os == 'ubuntu-latest' | |
| uses: docker/login-action@v2 | |
| with: | |
| registry: ghcr.io | |
| username: ${{ github.actor }} | |
| password: ${{ secrets.GITHUB_TOKEN }} | |
| - name: Run command to get SHA environment | |
| shell: bash | |
| run: echo "sha_short=$(git rev-parse --short HEAD)" >> ${GITHUB_ENV} | |
| # Note: These saves don't actually happen right away, as if you notice there is | |
| # no `dist` directory, when these are executed. The caching actually happens after | |
| # the goreleaser is ran which populates the `dist` directory, which is then picked | |
| # up in the job cleaning step that is ran end of this job. The step is a post-caching | |
| # cleanup step which notices the target directory is now populated and caches it. | |
| - name: Save cache on Linux | |
| if: matrix.os == 'ubuntu-latest' | |
| uses: actions/cache/save@v4 | |
| with: | |
| path: dist/linux_amd64 | |
| key: linux-${{ env.sha_short }} | |
| - name: Save cache on MacOS | |
| if: matrix.os == 'macos-latest' | |
| uses: actions/cache/save@v4 | |
| with: | |
| path: dist/darwin_amd64 | |
| key: darwin-${{ env.sha_short }} | |
| - name: Save cache on Windows | |
| if: matrix.os == 'windows-latest' | |
| uses: actions/cache/save@v4 | |
| with: | |
| path: dist/windows_amd64 | |
| key: windows-${{ env.sha_short }} | |
| enableCrossOsArchive: true | |
| # This is the step that actually `populates` the `dist` directory. | |
| - name: Run GoReleaser | |
| uses: goreleaser/goreleaser-action@v5 | |
| with: | |
| distribution: goreleaser-pro | |
| version: latest | |
| args: release --clean --split ${{ env.flags }} | |
| env: | |
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
| GITHUB_REPOSITORY: ${{ github.repository }} | |
| GORELEASER_KEY: ${{ secrets.GORELEASER_KEY }} | |
| # Cacheing actually happens, about here (once the above is ran). | |
| release: | |
| runs-on: ubuntu-latest | |
| needs: prepare | |
| steps: | |
| - name: Checkout code into the directory | |
| uses: actions/checkout@v3 | |
| with: | |
| fetch-depth: 0 | |
| - name: Apply tag | |
| run: git tag ${{ github.event.inputs.tag }} | |
| - name: Setup Go environment explicitly | |
| uses: actions/setup-go@v3 | |
| with: | |
| go-version: "1.21" | |
| check-latest: true | |
| cache: true | |
| - name: Log in to Docker Hub | |
| uses: docker/login-action@v2 | |
| with: | |
| username: ${{ secrets.DOCKER_USERNAME }} | |
| password: ${{ secrets.DOCKER_PASSWORD }} | |
| - name: Run command to get SHA environment | |
| shell: bash | |
| run: echo "sha_short=$(git rev-parse --short HEAD)" >> ${GITHUB_ENV} | |
| # Restore the cashes that were prepared for all OS | |
| - name: Restore from cache on Linux | |
| id: restore-linux | |
| uses: actions/cache/restore@v4 | |
| with: | |
| path: dist/linux_amd64 | |
| key: linux-${{ env.sha_short }} | |
| fail-on-cache-miss: true | |
| - name: Save from cache on MacOS | |
| id: restore-macos | |
| uses: actions/cache/restore@v4 | |
| with: | |
| path: dist/darwin_amd64 | |
| key: darwin-${{ env.sha_short }} | |
| fail-on-cache-miss: true | |
| - name: Restore from cache on Windows | |
| id: restore-windows | |
| uses: actions/cache/restore@v4 | |
| with: | |
| path: dist/windows_amd64 | |
| key: windows-${{ env.sha_short }} | |
| fail-on-cache-miss: true | |
| enableCrossOsArchive: true | |
| # Technically the following should never happen as we are using the `fail-on-cache-miss=true` | |
| # so it would fail before reaching here, but leaving for now incase the option is removed. | |
| - name: Exit if failed to restore cache for any OS | |
| if: | | |
| steps.restore-linux.outputs.cache-hit != 'true' || | |
| steps.restore-macos.outputs.cache-hit != 'true' || | |
| steps.restore-windows.outputs.cache-hit != 'true' | |
| run: exit 1 | |
| - name: Do the release, only if all OS caches were restored | |
| uses: goreleaser/goreleaser-action@v5 | |
| with: | |
| distribution: goreleaser-pro | |
| version: latest | |
| args: continue --merge | |
| env: | |
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
| GITHUB_REPOSITORY: ${{ github.repository }} | |
| GORELEASER_KEY: ${{ secrets.GORELEASER_KEY }} | |
| pull-docker-image: | |
| name: Pull docker image job | |
| runs-on: ubuntu-latest | |
| needs: prepare | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| image_tag: | |
| - sourcenetwork/defradb:latest | |
| - ghcr.io/sourcenetwork/defradb:latest | |
| steps: | |
| - name: Log in to Docker Hub | |
| uses: docker/login-action@v2 | |
| with: | |
| username: ${{ secrets.DOCKER_USERNAME }} | |
| password: ${{ secrets.DOCKER_PASSWORD }} | |
| - name: Pull Docker image | |
| run: docker pull ${{ matrix.image_tag }} | |
| - name: Test Docker image | |
| run: docker run --rm ${{ matrix.image_tag }} |