Enhance backend setup instructions in README #5
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: "TOC Generator" | |
| on: | |
| push: | |
| branches: | |
| - main | |
| pull_request: | |
| types: [opened, synchronize, reopened] | |
| permissions: | |
| contents: write # allow creating PRs and writing files via GITHUB_TOKEN | |
| jobs: | |
| generateTOC: | |
| name: "Generate/Update TOC" | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: "Checkout repository" | |
| uses: actions/checkout@v4 | |
| with: | |
| fetch-depth: 0 | |
| - name: "Run TOC Generator (technote-space/toc-generator)" | |
| uses: technote-space/toc-generator@v4 | |
| with: | |
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
| TARGET_PATHS: "README.md" # <-- note plural | |
| CREATE_PR: "true" # create a PR instead of forcing direct push | |
| COMMIT_MESSAGE: "chore(docs): update Table of Contents" | |
| PR_TITLE: "chore(docs): update Table of Contents (auto-generated)" | |
| PR_BODY: "This PR updates the README Table of Contents using technote-space/toc-generator." |