docs: Add Cobra docs generator and CI to ensure they remain up to date #2597
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 2022 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: code coverage | |
| on: [pull_request] | |
| # Declare default permissions as read only. | |
| permissions: read-all | |
| jobs: | |
| build: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Setup Go | |
| uses: actions/setup-go@41dfa10bad2bb2ae585af6ee5bb4d7d973ad74ed # v5.1.0 | |
| with: | |
| go-version: "1.23" | |
| - name: Checkout base branch | |
| uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 | |
| with: | |
| ref: ${{ github.base_ref }} | |
| - name: Calculate base code coverage | |
| run: | | |
| go test -short -coverprofile current_cover.out ./... || true | |
| export CUR_COVER=$(go tool cover -func current_cover.out | grep total | awk '{print substr($3, 1, length($3)-1)}') | |
| echo "CUR_COVER=$CUR_COVER" >> $GITHUB_ENV | |
| - name: Checkout PR branch | |
| uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 | |
| - name: Calculate PR code coverage | |
| run: | | |
| go test -short -coverprofile pr_cover.out ./... || true | |
| export PR_COVER=$(go tool cover -func pr_cover.out | grep total | awk '{print substr($3, 1, length($3)-1)}') | |
| echo "PR_COVER=$PR_COVER" >> $GITHUB_ENV | |
| - name: Verify code coverage. If your reading this and the step has failed, please add tests to cover your changes. | |
| run: | | |
| go tool cover -func pr_cover.out | |
| if [ "${{ env.PR_COVER }}" -lt "${{ env.CUR_COVER }}" ]; then | |
| exit 1; | |
| fi |