Check Go #1332
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
| # Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/check-go-task.md | |
| name: Check Go | |
| env: | |
| # See: https://github.com/actions/setup-go/tree/main#supported-version-syntax | |
| GO_VERSION: "1.17" | |
| # See: https://docs.github.com/actions/writing-workflows/choosing-when-your-workflow-runs/events-that-trigger-workflows | |
| on: | |
| create: | |
| push: | |
| paths: | |
| - ".github/workflows/check-go-task.ya?ml" | |
| - "Taskfile.ya?ml" | |
| - "**/go.mod" | |
| - "**/go.sum" | |
| - "**.go" | |
| pull_request: | |
| paths: | |
| - ".github/workflows/check-go-task.ya?ml" | |
| - "Taskfile.ya?ml" | |
| - "**/go.mod" | |
| - "**/go.sum" | |
| - "**.go" | |
| schedule: | |
| # Run periodically to catch breakage caused by external changes. | |
| - cron: "0 7 * * WED" | |
| workflow_dispatch: | |
| repository_dispatch: | |
| jobs: | |
| run-determination: | |
| runs-on: ubuntu-latest | |
| permissions: {} | |
| outputs: | |
| result: ${{ steps.determination.outputs.result }} | |
| steps: | |
| - name: Determine if the rest of the workflow should run | |
| id: determination | |
| run: | | |
| RELEASE_BRANCH_REGEX="refs/heads/[0-9]+.[0-9]+.x" | |
| # The `create` event trigger doesn't support `branches` filters, so it's necessary to use Bash instead. | |
| if [[ | |
| "${{ github.event_name }}" != "create" || | |
| "${{ github.ref }}" =~ $RELEASE_BRANCH_REGEX | |
| ]]; then | |
| # Run the other jobs. | |
| RESULT="true" | |
| else | |
| # There is no need to run the other jobs. | |
| RESULT="false" | |
| fi | |
| echo "result=$RESULT" >> $GITHUB_OUTPUT | |
| check-errors: | |
| name: check-errors (${{ matrix.module.path }}) | |
| needs: run-determination | |
| if: needs.run-determination.outputs.result == 'true' | |
| runs-on: ubuntu-latest | |
| permissions: | |
| contents: read | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| module: | |
| - path: ./ | |
| - path: docsgen | |
| - path: ruledocsgen | |
| steps: | |
| - name: Checkout repository | |
| uses: actions/checkout@v4 | |
| - name: Install Go | |
| uses: actions/setup-go@v5 | |
| with: | |
| go-version: ${{ env.GO_VERSION }} | |
| - name: Install Task | |
| uses: arduino/setup-task@v2 | |
| with: | |
| repo-token: ${{ secrets.GITHUB_TOKEN }} | |
| version: 3.x | |
| - name: Check for errors | |
| env: | |
| GO_MODULE_PATH: ${{ matrix.module.path }} | |
| run: task go:vet | |
| check-outdated: | |
| name: check-outdated (${{ matrix.module.path }}) | |
| needs: run-determination | |
| if: needs.run-determination.outputs.result == 'true' | |
| runs-on: ubuntu-latest | |
| permissions: | |
| contents: read | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| module: | |
| - path: ./ | |
| - path: docsgen | |
| - path: ruledocsgen | |
| steps: | |
| - name: Checkout repository | |
| uses: actions/checkout@v4 | |
| - name: Install Go | |
| uses: actions/setup-go@v5 | |
| with: | |
| go-version: ${{ env.GO_VERSION }} | |
| - name: Install Task | |
| uses: arduino/setup-task@v2 | |
| with: | |
| repo-token: ${{ secrets.GITHUB_TOKEN }} | |
| version: 3.x | |
| - name: Modernize usages of outdated APIs | |
| env: | |
| GO_MODULE_PATH: ${{ matrix.module.path }} | |
| run: task go:fix | |
| - name: Check if any fixes were needed | |
| run: git diff --color --exit-code | |
| check-style: | |
| name: check-style (${{ matrix.module.path }}) | |
| needs: run-determination | |
| if: needs.run-determination.outputs.result == 'true' | |
| runs-on: ubuntu-latest | |
| permissions: | |
| contents: read | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| module: | |
| - path: ./ | |
| - path: docsgen | |
| - path: ruledocsgen | |
| steps: | |
| - name: Checkout repository | |
| uses: actions/checkout@v4 | |
| - name: Install Go | |
| uses: actions/setup-go@v5 | |
| with: | |
| go-version: ${{ env.GO_VERSION }} | |
| - name: Install Task | |
| uses: arduino/setup-task@v2 | |
| with: | |
| repo-token: ${{ secrets.GITHUB_TOKEN }} | |
| version: 3.x | |
| - name: Install golint | |
| run: go install golang.org/x/lint/golint@latest | |
| - name: Check style | |
| env: | |
| GO_MODULE_PATH: ${{ matrix.module.path }} | |
| run: task --silent go:lint | |
| check-formatting: | |
| name: check-formatting (${{ matrix.module.path }}) | |
| needs: run-determination | |
| if: needs.run-determination.outputs.result == 'true' | |
| runs-on: ubuntu-latest | |
| permissions: | |
| contents: read | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| module: | |
| - path: ./ | |
| - path: docsgen | |
| - path: ruledocsgen | |
| steps: | |
| - name: Checkout repository | |
| uses: actions/checkout@v4 | |
| - name: Install Go | |
| uses: actions/setup-go@v5 | |
| with: | |
| go-version: ${{ env.GO_VERSION }} | |
| - name: Install Task | |
| uses: arduino/setup-task@v2 | |
| with: | |
| repo-token: ${{ secrets.GITHUB_TOKEN }} | |
| version: 3.x | |
| - name: Format code | |
| env: | |
| GO_MODULE_PATH: ${{ matrix.module.path }} | |
| run: task go:format | |
| - name: Check formatting | |
| run: git diff --color --exit-code | |
| check-config: | |
| name: check-config (${{ matrix.module.path }}) | |
| needs: run-determination | |
| if: needs.run-determination.outputs.result == 'true' | |
| runs-on: ubuntu-latest | |
| permissions: | |
| contents: read | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| module: | |
| - path: ./ | |
| - path: docsgen | |
| - path: ruledocsgen | |
| steps: | |
| - name: Checkout repository | |
| uses: actions/checkout@v4 | |
| - name: Install Go | |
| uses: actions/setup-go@v5 | |
| with: | |
| go-version: ${{ env.GO_VERSION }} | |
| - name: Install Task | |
| uses: arduino/setup-task@v2 | |
| with: | |
| repo-token: ${{ secrets.GITHUB_TOKEN }} | |
| version: 3.x | |
| - name: Run go mod tidy | |
| env: | |
| GO_MODULE_PATH: ${{ matrix.module.path }} | |
| run: task go:tidy | |
| - name: Check whether any tidying was needed | |
| run: git diff --color --exit-code |