34 lines
1.0 KiB
YAML
34 lines
1.0 KiB
YAML
name: Publish documentation
|
|
|
|
# publish the documentation on every merge to develop branch
|
|
on:
|
|
push:
|
|
branches:
|
|
- develop
|
|
|
|
# we don't want to have concurrent jobs, and we don't want to cancel running jobs to avoid broken publications
|
|
concurrency:
|
|
group: documentation
|
|
cancel-in-progress: false
|
|
|
|
jobs:
|
|
publish_documentation:
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- uses: actions/checkout@v3
|
|
|
|
# We need a recent PlantUML version to generate UML diagrams. The version from Ubuntu is outdated, so we
|
|
# need to replace the JAR file with a release from PlantUML's GitHub page.
|
|
- name: Install and update PlantUML
|
|
run: |
|
|
sudo apt-get install -y plantuml
|
|
wget https://github.com/plantuml/plantuml/releases/download/v1.2022.6/plantuml-1.2022.6.jar
|
|
sudo mv plantuml-1.2022.6.jar /usr/share/plantuml/plantuml.jar
|
|
plantuml -version
|
|
|
|
- name: Install virtual environment
|
|
run: make install_venv -C docs/mkdocs
|
|
|
|
- name: Publish documentation
|
|
run: make publish -C docs/mkdocs
|