Skip to content

chore: remove hiroz-bridge and Ros2Dds key expression format #976

chore: remove hiroz-bridge and Ros2Dds key expression format

chore: remove hiroz-bridge and Ros2Dds key expression format #976

Workflow file for this run

name: Docs
on:
push:
paths:
- 'docs/**'
- 'mkdocs.yml'
- '**.md'
- '.github/workflows/docs.yml'
pull_request:
paths:
- 'docs/**'
- 'mkdocs.yml'
- '**.md'
- '.github/workflows/docs.yml'
jobs:
build_doc:
name: Build documentation
runs-on: ubuntu-latest
permissions:
contents: read
steps:
- name: Checkout repository
uses: actions/checkout@v4
- name: Install Nix
uses: cachix/install-nix-action@v31
- name: Build MkDocs
run: |
sed -i 's|^site_url:.*|site_url: http://localhost/|' mkdocs.yml
nix develop '.#pureRust-ci' -c mkdocs build --strict
- name: Check example documentation coverage
run: |
nix develop '.#pureRust-ci' -c nu scripts/check-example-coverage.nu
- name: Check internal links
uses: lycheeverse/lychee-action@v2
with:
args: >-
--offline
--root-dir ${{ github.workspace }}/site
--exclude-path ${{ github.workspace }}/site/overrides
--config .lychee.toml
./site
fail: true
publish_doc:
name: Publish to GitHub Pages
if: github.ref == 'refs/heads/main'
needs: build_doc
runs-on: ubuntu-latest
permissions:
contents: write
steps:
- name: Checkout repository
uses: actions/checkout@v4
- name: Install Nix
uses: cachix/install-nix-action@v31
- name: Build MkDocs
run: |
nix develop '.#pureRust-ci' -c mkdocs build --strict
- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v4
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./site
clean_exclude: pr-preview/
force_orphan: false