follow-up to 90836a0fac
until a proper 'github-pages' environment is configured,
go back to the older working method.
Signed-off-by: Paul Donald <newtwen+github@gmail.com>
bump checkout to 6
Included is a selection of rules which flag common problems.
Lint
-JS ( ESlint )
-JSON ( https://github.com/eslint/json )
-JSDoc (comment matter) in the luci-base module
-Markdown ( https://github.com/eslint/markdown )
For JSON, mandate standard JSON (not JSONC or JSON5) format,
**/*.json checks across the whole repo.
For JS, mandate sourceType: 'script', otherwise the linter
errors out about return methods in modules which masks other
problems. There are a number of structural design changes
needed to bring this repo into compliance with standards.
Each JS file is an individual script, despite their module
like structure, so functions and classes offloaded to
'common' files (individual scripts and not modules) are
invisible to linters unless we define them under the 'globals'
key. Custom rules and parsers are also possible.
For JSDoc, mandate some common checks to ensure the repo
will generate consistent documentation which links and displays
well.
For MD, check also JS syntax inside MD, as well as MD itself.
JS checks inside MD are not strict.
Included also eslint-formatter-gha (-f gha) which comments
on PRs when problems are detected in code additions. Actions
show green when no errors are reported (warnings are a pass)
but the gha will comment about warnings.
Flag `--diff-filter=ACM` shows only additions, and not
deletions.
Signed-off-by: Paul Donald <newtwen+github@gmail.com>
Enable posting formality check comments and warn if 'Allow edits and
access to secrets by maintainers' is not checked.
Signed-off-by: George Sapkin <george@sapk.in>
With APK defaulted on openwrt:main, we should include packages with the
.apk file extension as artifacts. Also default the logging to V=s as
otherwise the APK version check won't be printed to stdout.
Signed-off-by: Daniel Nilsson <dannil+github@protonmail.com>
With the change of the Docker container not including pre-built
binaries [1], the previous version of the workflow fails as it still
expects those to be present in the upstream container while the new
versions runs a file called setup.sh if present to configure the
container.
By upgrading openwrt/gh-action-sdk workflow to v7, we make sure that
setup.sh is run and configures the container [2].
[1] 9b55784b18
[2] 0c00b28c11
Signed-off-by: Daniel Nilsson <dannil+github@protonmail.com>
Code quality scanning (for JavaScript, JSON, HTML) for pushes and PRs
to master.
A repo scan takes roughly 4 minutes.
Signed-off-by: Paul Donald <newtwen@gmail.com>
this will prevent a large amount of
deploy: <sha>
to openwrt/gh-pages branches when nothing there has changed
Note: it may not be a bad idea to have docs compile at every commit,
since docs do not change *that* often, and some action or process that
breaks is likely noticed sooner if docs that compile continuously
trigger any broken processes or workflows.
While all LuCI packages should always build fine, this allows others to
directly install those packages within test setups.
Signed-off-by: Paul Spooren <mail@aparcar.org>
the overview README contains links for the client and server side API,
it's a markdown file and therefore requires jekyll to run.
Signed-off-by: Paul Spooren <mail@aparcar.org>
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 <mail@aparcar.org>
