Skip to content

Merge pull request #252 from seqan/dependabot/github_actions/fsfe/reu… #40

Merge pull request #252 from seqan/dependabot/github_actions/fsfe/reu…

Merge pull request #252 from seqan/dependabot/github_actions/fsfe/reu… #40

Workflow file for this run

# SPDX-FileCopyrightText: 2006-2024 Knut Reinert & Freie Universität Berlin
# SPDX-FileCopyrightText: 2016-2024 Knut Reinert & MPI für molekulare Genetik
# SPDX-License-Identifier: CC0-1.0
name: Deploy documentation (https://docs.seqan.de/)
on:
push:
branches:
- main
# Enables a manual trigger, may run on any branch
workflow_dispatch:
concurrency:
group: docs-${{ github.event.pull_request.number || github.ref }}
cancel-in-progress: false
env:
TZ: Europe/Berlin
defaults:
run:
shell: bash -ex {0}
jobs:
deploy_documentation:
name: Deploy Documentation
runs-on: ubuntu-22.04
timeout-minutes: 30
if: github.repository_owner == 'seqan' || github.event_name == 'workflow_dispatch'
steps:
- name: Checkout
uses: actions/checkout@v4
with:
submodules: true
# To reuse scripts
- name: Checkout SeqAn3
uses: actions/checkout@v4
with:
repository: seqan/seqan3
ref: aa3df18a6df59679e07e9fe2de4e0998a94af7e7
path: seqan3
fetch-depth: 1
submodules: false
- name: Install CMake
uses: seqan/actions/setup-cmake@main
with:
cmake: 3.16.9
- name: Install Doxygen
uses: seqan/actions/setup-doxygen@main
with:
doxygen: 1.10.0
- name: Load cached documentation
uses: actions/cache@v4
with:
path: doc-build
key: ${{ runner.os }}-documentation-${{ env.DOXYGEN_VERSION }}
- name: Build documentation
run: |
mkdir -p doc-build
cd doc-build
cmake ../test/documentation
make download-cppreference-doxygen-web-tag
ctest . -j 2 --output-on-failure
- name: Deploy User Documentation
uses: Pendect/[email protected]
env:
DEPLOY_KEY: ${{ secrets.DEPLOY_HOST_SSH_KEY }}
REMOTE_HOST: ${{ secrets.DEPLOY_HOST }}
REMOTE_USER: ${{ secrets.REMOTE_USER }}
TARGET: ${{ secrets.REMOTE_TARGET }}
with:
flags: '-azr --delete --timeout=60 --omit-dir-times'
src: 'doc-build/doc_usr/html/'
dest: '$REMOTE_USER@$REMOTE_HOST:$TARGET/main_user'
- name: Deploy Developer Documentation
uses: Pendect/[email protected]
env:
DEPLOY_KEY: ${{ secrets.DEPLOY_HOST_SSH_KEY }}
REMOTE_HOST: ${{ secrets.DEPLOY_HOST }}
REMOTE_USER: ${{ secrets.REMOTE_USER }}
TARGET: ${{ secrets.REMOTE_TARGET }}
with:
flags: '-azr --delete --timeout=60 --omit-dir-times'
src: 'doc-build/doc_dev/html/'
dest: '$REMOTE_USER@$REMOTE_HOST:$TARGET/main_dev'