Publish docs and updater to git-pages
Some checks failed
ci / build-app-android (push) Has been skipped
ci / build-app-windows (push) Has been skipped
ci / build-app-appimage (push) Has been skipped
ci / publish-to-google-play (push) Has been skipped
ci / pages (push) Successful in 5m39s
ci / build-mcu (push) Successful in 8m42s
ci / deploy-beta-firmware (push) Failing after 24s
ci / build-update-info (push) Has been skipped
ci / changes (push) Successful in 15s
ci / build-app-debian (push) Successful in 16m21s
ci / upload-to-s3 (push) Has been skipped
ci / publish-to-aur (push) Has been skipped
ci / build-app-macos (push) Has been skipped

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
This commit is contained in:
Jonas Leder 2026-11-18 15:25:50 +01:00
commit 5d4c594f29
5 changed files with 31 additions and 6 deletions

View file

@ -403,3 +403,28 @@ jobs:
mc cp beta-buildinfo.json minio/$MINIO_BUCKET/beta/buildinfo.json
mc cp beta-manifest.json minio/$MINIO_BUCKET/beta/manifest.json
mc cp firmware.bin minio/$MINIO_BUCKET/beta/firmware.bin
pages:
if: github.ref_type == 'tag' || github.ref_name == github.event.repository.default_branch
runs-on: default
container:
image: node:26.13.1-bookworm
steps:
- uses: https://code.forgejo.org/actions/checkout@v7
- run: |
mkdir -p public/updater
apt update && apt install -y pandoc wkhtmltopdf
npm install -g pnpm@12.14.0
cd software/Firmwareupdater
pnpm install --frozen-lockfile
pnpm build
cp -r dist/* ../../public/updater/
cd ../..
bash docs/build-docs.sh public
- name: Publish to git-pages
env:
GIT_PAGES_TOKEN: ${{ github.token }}
run: |
curl -fsSL -o git-pages-cli https://codeberg.org/git-pages/git-pages-cli/releases/download/v1.13.1/git-pages-cli.linux-amd64
chmod +x git-pages-cli
./git-pages-cli https://jonasled.jonasled.dev/sfp-tool/ --upload-dir public

View file

@ -10,7 +10,7 @@ The repository now contains a CI-built documentation set under `docs/`.
- User manual source: `docs/user-manual.md`
- Hardware and software reference source: `docs/hardware-software-reference.md`
- GitLab Pages landing page: `/`
- Forgejo (git-pages) landing page: https://jonasled.jonasled.dev/sfp-tool/
- Published manuals: `/docs/*.html` and `/docs/*.pdf`
- Firmware recovery updater: `/updater/`
@ -42,4 +42,4 @@ In theory the app can be build for all major platforms. The macOS build is not s
If the firmware on the ESP breaks, or a update is required you can either download the latest firmware from the artifacts and do a manual upgrade using esptool ( required for crash-looping and brand new devices ) or use the Web based updater. Please note, this works only in Chronium based browsers, like Google Chrome or MS Edge.
Web based Updater: https://sfp-tool-ae2df9.jonasled.dev/
Web based Updater: https://jonasled.jonasled.dev/sfp-tool/updater/

View file

@ -231,7 +231,7 @@ The CI pipeline currently covers:
- Android app packaging
- object publication to S3-compatible storage
- Google Play deployment
- GitLab Pages publication for documentation and updater hosting
- git-pages publication for documentation and updater hosting
Documentation is generated from Markdown during CI and exported as both HTML and PDF.

View file

@ -19,7 +19,7 @@ SFP Tool combines portable hardware, embedded firmware, a cross-platform control
- Arch Linux: [sfptool](https://aur.archlinux.org/packages/sfptool) (source build) and [sfptool-bin](https://aur.archlinux.org/packages/sfptool-bin) (prebuilt `x86_64`)
- Firmware (stable): [firmware.bin](https://s3.jonasled.de/sfp-tool/firmware.bin)
- Firmware (beta): [firmware.bin](https://s3.jonasled.de/sfp-tool/beta/firmware.bin)
- Web firmware updater: [sfp-tool-ae2df9.jonasled.dev](https://sfp-tool-ae2df9.jonasled.dev/)
- Web firmware updater: [jonasled.jonasled.dev/sfp-tool/updater](https://jonasled.jonasled.dev/sfp-tool/updater/)
Replace `<version>` with the release number, for example `0.1.1`. Every tagged build and its CI artifacts are listed under the [Forgejo Actions runs](https://forgejo.jonasled.dev/jonasled/sfp-tool/actions).
@ -45,7 +45,7 @@ This documentation set is split into two main parts:
The CI pipeline publishes:
- HTML documentation for browsing on GitLab Pages.
- HTML documentation for browsing on git-pages (https://jonasled.jonasled.dev/sfp-tool/).
- PDF versions of the user manual and technical reference.
- The browser-based firmware updater.

View file

@ -1,7 +1,7 @@
import { isTauri } from "@tauri-apps/api/core";
import { openUrl } from "@tauri-apps/plugin-opener";
const DEFAULT_MANUAL_URL = "https://sfp-tool-ae2df9.jonasled.dev/docs/user-manual.pdf";
const DEFAULT_MANUAL_URL = "https://jonasled.jonasled.dev/sfp-tool/docs/user-manual.pdf";
export const USER_MANUAL_URL = (import.meta.env.VITE_USER_MANUAL_URL || DEFAULT_MANUAL_URL).trim();