From 8ea448adb8edc4324ccf83dfc1f52f610ae25793 Mon Sep 17 00:00:00 2001 From: rootiest Date: Mon, 8 Jun 2026 10:46:53 -0400 Subject: [PATCH] ci(html-docs): add automatically generated html docs --- .gitea/workflows/docs-drift.yml | 4 ++-- .gitea/workflows/html-docs.yml | 39 +++++++++++++++++++++++++++++++++ .gitea/workflows/man-page.yml | 4 ++-- 3 files changed, 43 insertions(+), 4 deletions(-) create mode 100644 .gitea/workflows/html-docs.yml diff --git a/.gitea/workflows/docs-drift.yml b/.gitea/workflows/docs-drift.yml index ee4b9df..d3a0a14 100644 --- a/.gitea/workflows/docs-drift.yml +++ b/.gitea/workflows/docs-drift.yml @@ -5,11 +5,11 @@ on: branches: - main paths: - - 'README.md' + - "README.md" jobs: remind: - runs-on: ubuntu-latest + runs-on: racknerd-mini steps: - name: Checkout uses: actions/checkout@v4 diff --git a/.gitea/workflows/html-docs.yml b/.gitea/workflows/html-docs.yml new file mode 100644 index 0000000..fac9cd5 --- /dev/null +++ b/.gitea/workflows/html-docs.yml @@ -0,0 +1,39 @@ +name: Generate HTML docs + +on: + push: + branches: + - main + paths: + - "docs/fish-config.md" + +jobs: + build-html-docs: + runs-on: racknerd-mini + steps: + - name: Checkout + env: + TOKEN: ${{ secrets.GITEA_TOKEN }} + run: | + HOST="${GITHUB_SERVER_URL#*://}" + SCHEME="${GITHUB_SERVER_URL%%://*}" + git clone --depth=1 --branch "${GITHUB_REF_NAME}" \ + "${SCHEME}://oauth2:${TOKEN}@${HOST}/${GITHUB_REPOSITORY}.git" . + + - name: Install pandoc + run: sudo apt-get update -qq && sudo apt-get install -y pandoc + + - name: Generate chunked HTML docs + run: | + pandoc -f gfm -t chunkedhtml --split-level=1 --toc -V toc=true \ + docs/fish-config.md \ + -o docs/html/ + + - name: Commit HTML docs + run: | + git config user.name "Gitea Actions" + git config user.email "actions@gitea" + git add docs/html/ + git diff --cached --quiet && echo "No changes to commit" && exit 0 + git commit -m "chore(docs): regenerate offline HTML docs" + git push diff --git a/.gitea/workflows/man-page.yml b/.gitea/workflows/man-page.yml index aedb464..bef3170 100644 --- a/.gitea/workflows/man-page.yml +++ b/.gitea/workflows/man-page.yml @@ -5,11 +5,11 @@ on: branches: - main paths: - - 'docs/fish-config.md' + - "docs/fish-config.md" jobs: build-manpage: - runs-on: ubuntu-latest + runs-on: racknerd-mini steps: - name: Checkout uses: actions/checkout@v4