Skip to content

Commit

Permalink
Add LDoc config file to exclude payload.lua
Browse files Browse the repository at this point in the history
There is currently a bug with `file` in LDoc, where LDoc will only recognise the `file` if the directory arg is `.`
lunarmodules/ldoc#351

This means cd'ing into `./src` is required to exclude files.
  • Loading branch information
greg-el committed Apr 12, 2022
1 parent 93987bb commit 082a35b
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 2 deletions.
5 changes: 3 additions & 2 deletions .github/workflows/publish.yml
Original file line number Diff line number Diff line change
Expand Up @@ -55,13 +55,14 @@ jobs:
run: |
wget https://github.com/lunarmodules/LDoc/archive/refs/tags/1.4.6.tar.gz &&
tar xf 1.4.6.tar.gz &&
lua ./LDoc-1.4.6/ldoc.lua ./src/
cd ./src/
lua ./LDoc-1.4.6/ldoc.lua .
- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./doc/
publish_dir: ./src/doc/

publish:
needs: "version_check"
Expand Down
15 changes: 15 additions & 0 deletions src/config.ld
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
title = "Tracker for Lua"
project = "Snowplow event tracker for Lua"

description = [[
With SnowplowTracker you can collect event data from your
Lua-based applications, Lua web servers/frameworks, or
from the Lua scripting layer within your games or apps.
]]

file = {
"snowplow",
exclude = {
"snowplow/payload.lua"
}
}

0 comments on commit 082a35b

Please sign in to comment.