docs: add git workflow guidelines to prevent force pushing #6911
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: Docs CI | |
| on: | |
| push: | |
| branches: | |
| - main | |
| paths: | |
| - "docs/**" | |
| - "**.md" | |
| - ".github/workflows/docs-ci.yaml" | |
| pull_request: | |
| paths: | |
| - "docs/**" | |
| - "**.md" | |
| - ".github/workflows/docs-ci.yaml" | |
| permissions: | |
| contents: read | |
| jobs: | |
| docs: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # v6.0.0 | |
| with: | |
| persist-credentials: false | |
| - name: Setup Node | |
| uses: ./.github/actions/setup-node | |
| - uses: tj-actions/changed-files@abdd2f68ea150cee8f236d4a9fb4e0f2491abf1b # v45.0.7 | |
| id: changed-files | |
| with: | |
| files: | | |
| docs/** | |
| **.md | |
| separator: "," | |
| - name: lint | |
| if: steps.changed-files.outputs.any_changed == 'true' | |
| run: | | |
| # shellcheck disable=SC2086 | |
| pnpm exec markdownlint-cli2 $ALL_CHANGED_FILES | |
| env: | |
| ALL_CHANGED_FILES: ${{ steps.changed-files.outputs.all_changed_files }} | |
| - name: fmt | |
| if: steps.changed-files.outputs.any_changed == 'true' | |
| run: | | |
| # markdown-table-formatter requires a space separated list of files | |
| # shellcheck disable=SC2086 | |
| echo $ALL_CHANGED_FILES | tr ',' '\n' | pnpm exec markdown-table-formatter --check | |
| env: | |
| ALL_CHANGED_FILES: ${{ steps.changed-files.outputs.all_changed_files }} |