1
0
mirror of https://github.com/RIOT-OS/RIOT.git synced 2025-12-25 14:33:52 +01:00
RIOT/.github/workflows/deploy_docs.yml
AnnsAnn e82ada6358 doc/guide: Introduce a Guide Site
doc/guides: How to Doc

fix: add starlight to base makefile
2025-04-24 12:35:53 +02:00

34 lines
1.0 KiB
YAML

name: Build Docs
on:
push:
branches:
- master
paths:
- 'doc/guides/**'
- 'doc/starlight/**'
jobs:
build-docs:
runs-on: ubuntu-latest
defaults:
run:
working-directory: doc/starlight
steps:
- name: Checkout repository
uses: actions/checkout@v4
- name: Set up Node.js
uses: actions/setup-node@v4
- name: Build documentation
run: make build
# This step will probably need to be changed to use the actual service RIOT is using
# This makes it more convenient to deploy while still in development though
- name: Deploy documentation
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: doc/starlight/dist
publish_branch: gh-pages
cname: guide.riot-os.org
commit_message: "Deploy documentation"