Skip to content

Feature/jenkins

Feature/jenkins #271

Workflow file for this run

# YAML schema for GitHub Actions:
# https://help.github.com/en/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions
#
# Helpful YAML parser to clarify YAML syntax:
# https://yaml-online-parser.appspot.com/
#
# This workflow uses actions that are not certified by GitHub. They are provided by a third-party and are governed by
# separate terms of service, privacy policy, and support documentation.
#
# This file contains the workflows that are run prior to merging a pull request.
name: Documentation
on:
push:
branches:
- 'develop'
- 'main'
pull_request:
branches:
- 'develop'
- 'main'
# Allow manually triggering of the workflow.
workflow_dispatch: {}
env:
DOC_BUILDER_IMAGE: 'ghcr.io/xmos/xmosdoc:v4.0'
jobs:
build_documentation:
name: Build and package documentation
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v2
with:
submodules: recursive
- name: Pull documentation builder docker image
run: |
docker pull ${DOC_BUILDER_IMAGE}
- name: Build documentation
run: |
docker run --rm -t -u "$(id -u):$(id -g)" -v ${{ github.workspace }}:/build ${DOC_BUILDER_IMAGE} -vv
- name: Save documentation artifacts
uses: actions/upload-artifact@v3
with:
name: fwk_io_docs
path: ./doc/_build
if-no-files-found: error # 'warn' or 'ignore' are also available, defaults to `warn`
retention-days: 5