Generate docs #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: Generate docs | |
| on: | |
| push: | |
| branches: | |
| - main | |
| paths: | |
| - "types/**" | |
| workflow_dispatch: | |
| jobs: | |
| generate-docs: | |
| permissions: | |
| contents: write | |
| pull-requests: write | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v6 | |
| - name: Checkout docs generator | |
| uses: actions/checkout@v6 | |
| with: | |
| repository: BlueLua/bluelua.github.io | |
| path: .docgen | |
| - name: Setup Lua | |
| uses: leafo/gh-actions-lua@v13 | |
| with: | |
| luaVersion: "luajit" | |
| - name: Generate docs | |
| run: luajit .docgen/scripts/generate-api-docs.lua types docs | |
| - name: Show generated changes | |
| run: git status --short | |
| - name: Open docs PR | |
| uses: peter-evans/create-pull-request@v7 | |
| with: | |
| commit-message: "docs: generate API docs" | |
| title: "docs: generate API docs" | |
| body: "Generate API docs from LuaLS type annotations." | |
| branch: automation/generate-docs | |
| add-paths: | | |
| docs/**/*.md |