Skip to content

bits not bytes

bits not bytes #18

Workflow file for this run

# This is a basic workflow to help you get started with Actions
name: Build HTML Docs
# Controls when the workflow will run
on:
# Triggers the workflow on push or pull request events but only for the "main" branch
push:
pull_request:
# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
contents: read
pages: write
id-token: write
# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
concurrency:
group: "pages"
cancel-in-progress: false
# A workflow run is made up of one or more jobs that can run sequentially or in parallel
jobs:
# This workflow contains a single job called "build"
build-docs:
# The type of runner that the job will run on
runs-on: ubuntu-latest
# Steps represent a sequence of tasks that will be executed as part of the job
steps:
# Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
- uses: actions/checkout@v4
- uses: actions/checkout@v4
with:
repository: OpenCyphal/public_regulated_data_types
path: public_regulated_data_types
- name: Setup Python
uses: actions/setup-python@v4
with:
python-version: '3.11'
# cache: 'pip' # caching pip dependencies
- name: Install Nunavut
run: pip install -U nunavut
# Runs a set of commands using the runners shell
- name: Build CWRUBaja DSDL Docs
run: |
nnvg \
--target-language html \
--target-endianness little \
--enable-serialization-asserts \
--experimental-languages \
cwrubaja \
--outdir nunavut_out \
--lookup-dir public_regulated_data_types/uavcan \
--lookup-dir public_regulated_data_types/reg
# - name: Share build artifacts
# uses: actions/upload-artifact@v4
# with:
# name: docs-artifacts
# path: nunavut_out/
# compression-level: 9 # maximum compression
# retention-days: 30
# - name: Deploy 🚀
# uses: JamesIves/github-pages-deploy-action@v4
# with:
# folder: nunavut_out # The folder the action should deploy.
- name: Setup Pages
uses: actions/configure-pages@v4
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
# Upload our docs
path: 'nunavut_out/cwrubaja/'
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4