Merge pull request #463 from vitessio/revert-462-wip-pr-test #1357
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: Verify CLI Documentation | |
| on: [push, pull_request] | |
| jobs: | |
| build: | |
| name: Verify CLI Documentation | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v3 | |
| - name: Set up Go | |
| uses: actions/setup-go@v4 | |
| with: | |
| go-version: 1.21.3 | |
| - name: Run gen doc | |
| run: | | |
| set -e | |
| make gendoc | |
| output=$(git status -s) | |
| if [ -z "${output}" ]; then | |
| exit 0 | |
| fi | |
| echo 'We wish to maintain a clean documentation. Please run the command `go run ./go/main.go gen doc` on your branch, commit and push again.' | |
| echo 'Running `go run ./go/main.go gen doc` on this CI test yields with the following changes:' | |
| echo "$output" | |
| exit 1 |