From 56ef04849d46d355eccea8482cba43ec7ba582f6 Mon Sep 17 00:00:00 2001 From: Paul Spooren Date: Wed, 6 Oct 2021 16:35:46 -1000 Subject: [PATCH] CI: automatically update jsapi docs Use a GitHub Action to keep the docs updated, the current onces are 14 month old and outdated. Use latest jsdoc package Add full URL to LuCI.html file in README.md Ignore generated HTML files via .gitignore Signed-off-by: Paul Spooren --- .github/workflows/jsdoc.yml | 31 +++++++++++++++++++++++++++++++ .gitignore | 2 ++ docs/jsapi/README.md | 5 +++++ package.json | 4 ++-- 4 files changed, 40 insertions(+), 2 deletions(-) create mode 100644 .github/workflows/jsdoc.yml create mode 100644 docs/jsapi/README.md diff --git a/.github/workflows/jsdoc.yml b/.github/workflows/jsdoc.yml new file mode 100644 index 0000000000..dd9d952176 --- /dev/null +++ b/.github/workflows/jsdoc.yml @@ -0,0 +1,31 @@ +name: GitHub pages + +on: + push: + branches: + - master + +jobs: + deploy: + runs-on: ubuntu-latest + steps: + - name: Checkout code + uses: actions/checkout@v2 + + - name: Install + run: npm install + + - name: Build + run: npm run doc + + - name: Archive docs as artifact + uses: actions/upload-artifact@v2 + with: + name: docs + path: ./docs/ + + - name: Deploy + uses: peaceiris/actions-gh-pages@v3 + with: + deploy_key: ${{ secrets.ACTIONS_DEPLOY_KEY }} + publish_dir: ./docs/ diff --git a/.gitignore b/.gitignore index 75c5bef98f..60dd7e18d6 100644 --- a/.gitignore +++ b/.gitignore @@ -12,3 +12,5 @@ modules/luci-base/src/jsmin modules/luci-base/src/contrib/lemon modules/luci-base/src/plural_formula.c modules/luci-base/src/plural_formula.h +docs/jsapi/* +!docs/jsapi/README.md diff --git a/docs/jsapi/README.md b/docs/jsapi/README.md new file mode 100644 index 0000000000..ecd93766ad --- /dev/null +++ b/docs/jsapi/README.md @@ -0,0 +1,5 @@ +# LuCI client side API documentation + +You can browse the JavaScript apis provided by LuCI here. A good starting point +is the central [luci.js class](https://openwrt.github.io/luci/jsapi/LuCI.html). + diff --git a/package.json b/package.json index dfa03493c8..e4664e08cf 100644 --- a/package.json +++ b/package.json @@ -3,7 +3,7 @@ "doc": "LC_ALL=C jsdoc -c jsdoc.conf.json -t node_modules/jaguarjs-jsdoc" }, "devDependencies": { - "jsdoc": "^3.6.3", - "jaguarjs-jsdoc": "^1.1.0" + "jaguarjs-jsdoc": "^1.1.0", + "jsdoc": "^3.6.7" } } -- 2.30.2