Wiki replacement and CI update (#86)

* dhcp uses on, not true (because iocage syntax)

* Documentation updates

* Add gh-pages wiki generator using mkdocs

* Update shellcheck.yml

* Update wiki.yml

* Add filecheck

* readme case correction1

* readme case correction2

* Update filecheck.yml
This commit is contained in:
Kjeld Schouten-Lebbing
2020-04-26 16:00:47 +02:00
committed by GitHub
parent c32ea280da
commit 2c75cfe0ea
26 changed files with 239 additions and 21 deletions

21
.github/workflows/filecheck.yml vendored Normal file
View File

@ -0,0 +1,21 @@
name: File Presence QC
on:
pull_request:
branches:
- master
- dev
jobs:
build:
name: Check Files
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v1
- name: check existance
run: |
for pathname in jails/*; do test -e $pathname/readme.md || { echo "File missing: $pathname/readme.md"; error="true"; }; done
for pathname in jails/*; do test -e $pathname/install.sh || { echo "File missing: $pathname/install.sh"; error="true"; }; done
for pathname in jails/*; do test -e $pathname/update.sh || { echo "File missing: $pathname/update.sh"; error="true"; }; done
for pathname in jails/*; do test -e $pathname/config.yml || { echo "File missing: $pathname/config.yml"; error="true"; }; done
if [ "${error}" == "true" ]; then echo "Missing files detected" && exit 1; fi
shell: bash

View File

@ -1,5 +1,5 @@
# This is a workflow to run shellcheck on all scripts
name: Shellcheck Workflow
name: Shell Linter QC
# Controls when the action will run. Triggers the workflow on push or pull request
# events but only for the master branch
@ -10,7 +10,7 @@ on:
- dev
jobs:
shellcheck:
Shellcheck:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v1

26
.github/workflows/wiki.yml vendored Normal file
View File

@ -0,0 +1,26 @@
name: Publish docs via GitHub Pages
on:
push:
branches:
- master
jobs:
build:
name: Deploy docs
runs-on: ubuntu-latest
steps:
- name: Checkout master
uses: actions/checkout@v1
with:
ref: 'master'
- name: rename-readme
run: |
for pathname in jails/*/README.MD; do ! cp "$pathname" "docs/jails/$( basename "$( dirname "$pathname" )" ).md"; done
for pathname in jails/*/README.md; do ! cp "$pathname" "docs/jails/$( basename "$( dirname "$pathname" )" ).md"; done
for pathname in jails/*/readme.md; do ! cp "$pathname" "docs/jails/$( basename "$( dirname "$pathname" )" ).md"; done
for pathname in jails/*/Readme.md; do ! cp "$pathname" "docs/jails/$( basename "$( dirname "$pathname" )" ).md"; done
shell: bash
- name: Deploy docs
uses: mhausenblas/mkdocs-deploy-gh-pages@master
env:
GITHUB_TOKEN: ${{ secrets.WIKI_GH_PAT }}