Core/BossPrototype: Fix docs #209
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: Generate docs | |
| on: | |
| push: | |
| branches: | |
| - master | |
| paths: | |
| - ldoc.ltp | |
| - Core/BossPrototype.lua | |
| - Core/PluginPrototype.lua | |
| jobs: | |
| ldoc: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout BigWigs | |
| uses: actions/checkout@v4 | |
| with: | |
| path: BigWigs | |
| - name: Checkout BigWigs.wiki | |
| uses: actions/checkout@v4 | |
| with: | |
| repository: BigWigsMods/BigWigs.wiki | |
| path: wiki | |
| - name: Install ldoc | |
| run: | | |
| sudo apt-get install luarocks | |
| sudo luarocks install ldoc 1.4.6-2 | |
| - name: ldoc PluginPrototype | |
| run: ldoc --fatalwarnings -q -x md -l BigWigs -p BigWigs BigWigs/Core/PluginPrototype.lua && cp -av PluginPrototype.md wiki/ | |
| - name: ldoc BossPrototype | |
| if: always() | |
| run: ldoc --fatalwarnings -q -x md -l BigWigs -p BigWigs BigWigs/Core/BossPrototype.lua && cp -av BossPrototype.md wiki/ | |
| - name: Update wiki | |
| run: | | |
| cd wiki | |
| git config user.name "${GITHUB_ACTOR}" | |
| git config user.email "<>" | |
| git commit -am "Update API docs from ${GITHUB_SHA:0:7}" || true | |
| git push |