internal/readme: use go:generate rather than Make #71
Workflow file for this run
This file contains hidden or 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: README Check | |
| on: | |
| workflow_dispatch: | |
| pull_request: | |
| paths: | |
| - 'internal/readme/**' | |
| - 'README.md' | |
| permissions: | |
| contents: read | |
| jobs: | |
| readme-check: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Set up Go | |
| uses: actions/setup-go@v5 | |
| - name: Check out code | |
| uses: actions/checkout@v4 | |
| - name: Check README is up-to-date | |
| run: | | |
| go generate ./internal/readme | |
| if [ -n "$(git status --porcelain)" ]; then | |
| echo "ERROR: README.md is not up-to-date!" | |
| echo "" | |
| echo "The README.md file differs from what would be generated by `go generate ./internal/readme`." | |
| echo "Please update internal/readme/README.src.md instead of README.md directly," | |
| echo "then run `go generate ./internal/readme` to regenerate README.md." | |
| echo "" | |
| echo "Changes:" | |
| git status --porcelain | |
| echo "" | |
| echo "Diff:" | |
| git diff | |
| exit 1 | |
| fi | |
| echo "README.md is up-to-date" |