docs: Add Cobra docs generator and CI to ensure they remain up to date #6699
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
| # Copyright 2020 Google LLC | |
| # | |
| # Licensed under the Apache License, Version 2.0 (the "License"); | |
| # you may not use this file except in compliance with the License. | |
| # You may obtain a copy of the License at | |
| # | |
| # http://www.apache.org/licenses/LICENSE-2.0 | |
| # | |
| # Unless required by applicable law or agreed to in writing, software | |
| # distributed under the License is distributed on an "AS IS" BASIS, | |
| # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | |
| # See the License for the specific language governing permissions and | |
| # limitations under the License. | |
| name: tests | |
| on: | |
| push: | |
| branches: | |
| - "main" | |
| - "v1" | |
| pull_request: | |
| schedule: | |
| - cron: "0 2 * * *" | |
| # Declare default permissions as read only. | |
| permissions: read-all | |
| jobs: | |
| compilation: | |
| name: FreeBSD and OpenBSD compilation check | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout code | |
| uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 | |
| - name: Setup Go | |
| uses: actions/setup-go@41dfa10bad2bb2ae585af6ee5bb4d7d973ad74ed # v5.1.0 | |
| with: | |
| go-version: "1.23" | |
| - name: Verify FreeBSD and OpenBSD Builds | |
| run: | | |
| CGO_ENABLED=0 GOOS=freebsd go build | |
| CGO_ENABLED=0 GOOS=openbsd go build | |
| integration: | |
| name: integration tests | |
| # run integration tests on all builds except pull requests from forks or dependabot | |
| if: | | |
| github.event_name != 'pull_request' || | |
| (github.event.pull_request.head.repo.full_name == github.repository && github.actor != 'dependabot[bot]') | |
| runs-on: ${{ matrix.os }} | |
| strategy: | |
| matrix: | |
| os: [macos-latest, windows-latest, ubuntu-latest] | |
| fail-fast: false | |
| permissions: | |
| contents: read | |
| id-token: write | |
| issues: write | |
| pull-requests: write | |
| steps: | |
| - name: Checkout code | |
| uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 | |
| - name: Setup Go | |
| uses: actions/setup-go@41dfa10bad2bb2ae585af6ee5bb4d7d973ad74ed # v5.1.0 | |
| with: | |
| go-version: "1.23" | |
| - id: auth | |
| name: Authenticate to Google Cloud | |
| uses: google-github-actions/auth@6fc4af4b145ae7821d527454aa9bd537d1f2dc5f # v2.1.7 | |
| with: | |
| workload_identity_provider: ${{ vars.PROVIDER_NAME }} | |
| service_account: ${{ vars.SERVICE_ACCOUNT }} | |
| access_token_lifetime: 600s | |
| - name: Set up Cloud SDK | |
| uses: google-github-actions/setup-gcloud@6189d56e4096ee891640bb02ac264be376592d6a # v2.1.2 | |
| - id: secrets | |
| name: Get secrets | |
| uses: google-github-actions/get-secretmanager-secrets@e5bb06c2ca53b244f978d33348d18317a7f263ce # v2.2.2 | |
| with: | |
| secrets: |- | |
| MYSQL_CONNECTION_NAME:${{ vars.GOOGLE_CLOUD_PROJECT }}/MYSQL_CONNECTION_NAME | |
| MYSQL_USER:${{ vars.GOOGLE_CLOUD_PROJECT }}/MYSQL_USER | |
| MYSQL_PASS:${{ vars.GOOGLE_CLOUD_PROJECT }}/MYSQL_PASS | |
| MYSQL_DB:${{ vars.GOOGLE_CLOUD_PROJECT }}/MYSQL_DB | |
| POSTGRES_CONNECTION_NAME:${{ vars.GOOGLE_CLOUD_PROJECT }}/POSTGRES_CONNECTION_NAME | |
| POSTGRES_USER:${{ vars.GOOGLE_CLOUD_PROJECT }}/POSTGRES_USER | |
| POSTGRES_USER_IAM:${{ vars.GOOGLE_CLOUD_PROJECT }}/POSTGRES_USER_IAM | |
| POSTGRES_PASS:${{ vars.GOOGLE_CLOUD_PROJECT }}/POSTGRES_PASS | |
| POSTGRES_DB:${{ vars.GOOGLE_CLOUD_PROJECT }}/POSTGRES_DB | |
| POSTGRES_CAS_CONNECTION_NAME:${{ vars.GOOGLE_CLOUD_PROJECT }}/POSTGRES_CAS_CONNECTION_NAME | |
| POSTGRES_CAS_PASS:${{ vars.GOOGLE_CLOUD_PROJECT }}/POSTGRES_CAS_PASS | |
| SQLSERVER_CONNECTION_NAME:${{ vars.GOOGLE_CLOUD_PROJECT }}/SQLSERVER_CONNECTION_NAME | |
| SQLSERVER_USER:${{ vars.GOOGLE_CLOUD_PROJECT }}/SQLSERVER_USER | |
| SQLSERVER_PASS:${{ vars.GOOGLE_CLOUD_PROJECT }}/SQLSERVER_PASS | |
| SQLSERVER_DB:${{ vars.GOOGLE_CLOUD_PROJECT }}/SQLSERVER_DB | |
| IMPERSONATED_USER:${{ vars.GOOGLE_CLOUD_PROJECT }}/IMPERSONATED_USER | |
| - name: Enable fuse config (Linux) | |
| if: runner.os == 'Linux' | |
| run: | | |
| sudo sed -i 's/#user_allow_other/user_allow_other/g' /etc/fuse.conf | |
| - name: Run tests | |
| env: | |
| GOOGLE_CLOUD_PROJECT: "${{ vars.GOOGLE_CLOUD_PROJECT }}" | |
| MYSQL_CONNECTION_NAME: "${{ steps.secrets.outputs.MYSQL_CONNECTION_NAME }}" | |
| MYSQL_USER: "${{ steps.secrets.outputs.MYSQL_USER }}" | |
| MYSQL_PASS: "${{ steps.secrets.outputs.MYSQL_PASS }}" | |
| MYSQL_DB: "${{ steps.secrets.outputs.MYSQL_DB }}" | |
| POSTGRES_CONNECTION_NAME: "${{ steps.secrets.outputs.POSTGRES_CONNECTION_NAME }}" | |
| POSTGRES_USER: "${{ steps.secrets.outputs.POSTGRES_USER }}" | |
| POSTGRES_USER_IAM: "${{ steps.secrets.outputs.POSTGRES_USER_IAM }}" | |
| POSTGRES_PASS: "${{ steps.secrets.outputs.POSTGRES_PASS }}" | |
| POSTGRES_DB: "${{ steps.secrets.outputs.POSTGRES_DB }}" | |
| POSTGRES_CAS_CONNECTION_NAME: "${{ steps.secrets.outputs.POSTGRES_CAS_CONNECTION_NAME }}" | |
| POSTGRES_CAS_PASS: "${{ steps.secrets.outputs.POSTGRES_CAS_PASS }}" | |
| SQLSERVER_CONNECTION_NAME: "${{ steps.secrets.outputs.SQLSERVER_CONNECTION_NAME }}" | |
| SQLSERVER_USER: "${{ steps.secrets.outputs.SQLSERVER_USER }}" | |
| SQLSERVER_PASS: "${{ steps.secrets.outputs.SQLSERVER_PASS }}" | |
| SQLSERVER_DB: "${{ steps.secrets.outputs.SQLSERVER_DB }}" | |
| IMPERSONATED_USER: "${{ steps.secrets.outputs.IMPERSONATED_USER }}" | |
| TMPDIR: "/tmp" | |
| TMP: "${{ runner.temp }}" | |
| # specifying bash shell ensures a failure in a piped process isn't lost by using `set -eo pipefail` | |
| shell: bash | |
| run: | | |
| go test -race -v ./... | tee test_results.txt | |
| - name: Convert test output to XML | |
| if: ${{ (github.event_name == 'schedule' || github.event_name == 'push') && always() }} | |
| run: | | |
| go install github.com/jstemmer/go-junit-report/v2@latest | |
| go-junit-report -in test_results.txt -set-exit-code -out integration_sponge_log.xml | |
| - name: FlakyBot (Linux) | |
| # only run flakybot on periodic (schedule) and continuous (push) events | |
| if: ${{ (github.event_name == 'schedule' || github.event_name == 'push') && runner.os == 'Linux' && always() }} | |
| run: | | |
| curl https://github.com/googleapis/repo-automation-bots/releases/download/flakybot-1.1.0/flakybot -o flakybot -s -L | |
| chmod +x ./flakybot | |
| ./flakybot --repo ${{github.repository}} --commit_hash ${{github.sha}} --build_url https://github.com/${{github.repository}}/actions/runs/${{github.run_id}} | |
| - name: FlakyBot (Windows) | |
| # only run flakybot on periodic (schedule) and continuous (push) events | |
| if: ${{ (github.event_name == 'schedule' || github.event_name == 'push') && runner.os == 'Windows' && always() }} | |
| run: | | |
| curl https://github.com/googleapis/repo-automation-bots/releases/download/flakybot-1.1.0/flakybot.exe -o flakybot.exe -s -L | |
| ./flakybot.exe --repo ${{github.repository}} --commit_hash ${{github.sha}} --build_url https://github.com/${{github.repository}}/actions/runs/${{github.run_id}} | |
| - name: FlakyBot (macOS) | |
| # only run flakybot on periodic (schedule) and continuous (push) events | |
| if: ${{ (github.event_name == 'schedule' || github.event_name == 'push') && runner.os == 'macOS' && always() }} | |
| run: | | |
| curl https://github.com/googleapis/repo-automation-bots/releases/download/flakybot-1.1.0/flakybot-darwin-amd64 -o flakybot -s -L | |
| chmod +x ./flakybot | |
| ./flakybot --repo ${{github.repository}} --commit_hash ${{github.sha}} --build_url https://github.com/${{github.repository}}/actions/runs/${{github.run_id}} | |
| unit: | |
| name: unit tests | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Setup Go | |
| uses: actions/setup-go@41dfa10bad2bb2ae585af6ee5bb4d7d973ad74ed # v5.1.0 | |
| with: | |
| go-version: 1.23 | |
| - name: Checkout code | |
| uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 | |
| - name: Run tests | |
| # specifying bash shell ensures a failure in a piped process isn't lost by using `set -eo pipefail` | |
| shell: bash | |
| run: | | |
| go test -v -race -short ./... |