Skip to content

Update README.md

Update README.md #23

Workflow file for this run

name: CI
on: [push, pull_request]
permissions:
actions: write
checks: write
contents: write
deployments: write
id-token: write
issues: write
discussions: write
packages: write
pages: write
pull-requests: write
repository-projects: write
security-events: write
statuses: write
jobs:
linter:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
with:
path: lilia
- uses: leafo/[email protected]
with:
luaVersion: "5.2"
- uses: leafo/[email protected]
- 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: lilia
run: luacheck . --no-redefined
--no-global --no-self
--no-max-line-length --no-max-code-line-length
--no-max-string-line-length --no-max-comment-line-length
--no-max-cyclomatic-complexity
docs:
runs-on: ubuntu-latest
needs: linter
steps:
- uses: actions/checkout@v2
with:
path: skeleton
- uses: leafo/[email protected]
with:
luaVersion: "5.2"
- uses: leafo/[email protected]
- name: Pull LDoc
uses: actions/checkout@v2
with:
repository: bleonheart/LDoc
path: ldoc
- name: Build LDoc
working-directory: ldoc
run: luarocks make
- name: Build docs
working-directory: skeleton
run: ldoc . --fatalwarnings
- name: Copy assets
working-directory: skeleton
run: |
cp -v docs/css/* docs/html
cp -v docs/js/* docs/html
- name: Deploy
if: github.event_name == 'push' && github.ref == 'refs/heads/main' && github.repository == 'LiliaFramework/Skeleton' && success()
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: skeleton/docs/html