| 1 | # Reference: https://github.com/Yash-Singh1/eslint-plugin-userscripts/blob/main/.github/workflows/readme-in-sync.yml |
| 2 | |
| 3 | name: Check if README and docs/README are in sync |
| 4 | |
| 5 | on: |
| 6 | push: |
| 7 | branches: |
| 8 | - gh-pages |
| 9 | pull_request: |
| 10 | branches: |
| 11 | - gh-pages |
| 12 | |
| 13 | permissions: |
| 14 | contents: read |
| 15 | |
| 16 | jobs: |
| 17 | check-readme: |
| 18 | runs-on: ubuntu-latest |
| 19 | steps: |
| 20 | - name: Checkout repository |
| 21 | uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 |
| 22 | |
| 23 | - name: Check for difference in README.md and docs/README.md |
| 24 | run: | |
| 25 | if [ -z "$(diff README.md docs/README.md --brief)" ] |
| 26 | then |
| 27 | echo "README.md and docs/README.md are in sync" |
| 28 | else |
| 29 | echo "Make sure that README.md and docs/README.md are in sync" |
| 30 | echo |
| 31 | echo "Difference:" |
| 32 | echo |
| 33 | diff README.md docs/README.md -u |
| 34 | exit 1 |
| 35 | fi |
| 36 | |