Add missing documentation for all the shared hooks (and some other) + Fix some inaccuracies #698
Workflow file for this run
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: CI | |
| on: [push, pull_request] | |
| jobs: | |
| linter: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v2 | |
| with: | |
| path: helix | |
| - uses: leafo/gh-actions-lua@v8.0.0 | |
| with: | |
| luaVersion: "5.2" | |
| - uses: leafo/gh-actions-luarocks@v4.0.0 | |
| - name: Pull gluacheck | |
| uses: actions/checkout@v2 | |
| with: | |
| repository: impulsh/gluacheck | |
| path: luacheck | |
| - name: Build gluacheck | |
| working-directory: luacheck | |
| run: luarocks make | |
| - name: Lint | |
| working-directory: helix | |
| run: luacheck . | |
| docs: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v2 | |
| with: | |
| path: helix | |
| - uses: leafo/gh-actions-lua@v8.0.0 | |
| with: | |
| luaVersion: "5.2" | |
| - uses: leafo/gh-actions-luarocks@v4.0.0 | |
| - name: Pull LDoc | |
| uses: actions/checkout@v2 | |
| with: | |
| repository: impulsh/LDoc | |
| path: ldoc | |
| - name: Build LDoc | |
| working-directory: ldoc | |
| run: luarocks make | |
| - name: Build docs | |
| working-directory: helix | |
| run: ldoc . --fatalwarnings | |
| - name: Copy assets | |
| working-directory: helix | |
| run: | | |
| cp -v docs/css/* docs/html | |
| cp -v docs/js/* docs/html | |
| - name: Deploy | |
| if: github.event_name == 'push' && github.ref == 'refs/heads/master' && github.repository == 'NebulousCloud/helix' && success() | |
| uses: peaceiris/actions-gh-pages@v3 | |
| with: | |
| github_token: ${{ secrets.GITHUB_TOKEN }} | |
| publish_dir: helix/docs/html | |
| cname: docs.gethelix.co |