(docs) update docs #2
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: Update TOC | |
| on: | |
| push: | |
| branches: [main] | |
| paths: ['README.md'] | |
| jobs: | |
| build: | |
| runs-on: ubuntu-latest | |
| permissions: | |
| # Give the default GITHUB_TOKEN write permission. | |
| # https://github.blog/changelog/2023-02-02-github-actions-updating-the-default-github_token-permissions-to-read-only/ | |
| contents: write | |
| timeout-minutes: 5 | |
| steps: | |
| - uses: actions/checkout@v4.2.2 | |
| - run: | | |
| curl https://raw.githubusercontent.com/ekalinin/github-markdown-toc/master/gh-md-toc -o gh-md-toc | |
| chmod a+x gh-md-toc | |
| ./gh-md-toc --insert --no-backup README.md | |
| - uses: stefanzweifel/git-auto-commit-action@v5.1.0 | |
| with: | |
| commit_message: Auto update markdown TOC |