Skip to content

Commit

Permalink
update CI for docs
Browse files Browse the repository at this point in the history
  • Loading branch information
foolnotion committed May 29, 2024
1 parent 5cb970a commit 1441240
Showing 1 changed file with 10 additions and 142 deletions.
152 changes: 10 additions & 142 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,167 +3,35 @@ name: Continuous Integration
on:
push:
branches:
- master
- main

pull_request:
branches:
- master
- main

jobs:
lint:
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v2

- uses: actions/setup-python@v2
with: { python-version: "3.8" }

- name: Install codespell
run: pip3 install codespell

- name: Lint
run: cmake -D FORMAT_COMMAND=clang-format-11 -P cmake/lint.cmake

- name: Spell check
if: always()
run: cmake -P cmake/spell.cmake

coverage:
needs: [lint]

runs-on: ubuntu-latest

# To enable coverage, go to https://codecov.io/, acquire a token, put it
# into your secrets (Settings > Secrets > New repository secret), delete
# the last line from the conditional below and edit the "<name>"
# placeholder to your GitHub name.
# If you do not wish to use codecov, then simply delete this job from the
# workflow.
if: github.repository_owner == '<name>'
&& false

steps:
- uses: actions/checkout@v2

- name: Install LCov
run: sudo apt-get update -q
&& sudo apt-get install lcov -q -y

- name: Configure
run: cmake --preset=ci-coverage

- name: Build
run: cmake --build build/coverage -j 2

- name: Test
working-directory: build/coverage
run: ctest --output-on-failure -j 2

- name: Process coverage info
run: cmake --build build/coverage -t coverage

- name: Submit to codecov.io
uses: codecov/codecov-action@v1
with:
file: build/coverage/coverage.info

sanitize:
needs: [lint]

runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v2

- name: Configure
env: { CXX: clang++-11 }
run: cmake --preset=ci-sanitize

- name: Build
run: cmake --build build/sanitize -j 2

- name: Test
working-directory: build/sanitize
env:
ASAN_OPTIONS: "strict_string_checks=1:\
detect_stack_use_after_return=1:\
check_initialization_order=1:\
strict_init_order=1:\
detect_leaks=1"
UBSAN_OPTIONS: print_stacktrace=1
run: ctest --output-on-failure -j 2

test:
needs: [lint]

strategy:
matrix:
os: [macos, ubuntu, windows]

runs-on: ${{ matrix.os }}-latest

steps:
- uses: actions/checkout@v2

- name: Install static analyzers
if: matrix.os == 'ubuntu'
run: sudo apt-get install clang-tidy cppcheck -y -q

- name: Configure
run: cmake --preset=ci-${{ matrix.os }}

- name: Build
run: cmake --build build --config Release -j 2

- name: Install
run: cmake --install build --config Release --prefix prefix

- name: Test
working-directory: build
run: ctest --output-on-failure -C Release -j 2

docs:
# Deploy docs only when builds succeed
needs: [sanitize, test]

runs-on: ubuntu-latest

# To enable, first you have to create an orphaned gh-pages branch:
#
# git switch --orphan gh-pages
# git commit --allow-empty -m "Initial commit"
# git push -u origin gh-pages
#
# Edit the <name> placeholder below to your GitHub name, so this action
# runs only in your repository and no one else's fork. After these, delete
# this comment and the last line in the conditional below.
# If you do not wish to use GitHub Pages for deploying documentation, then
# simply delete this job similarly to the coverage one.
if: github.ref == 'refs/heads/master'
if: github.ref == 'refs/heads/main'
&& github.event_name == 'push'
&& github.repository_owner == '<name>'
&& false
&& github.repository_owner == 'heal-research'

steps:
- uses: actions/checkout@v2

- uses: actions/setup-python@v2
with: { python-version: "3.8" }

- name: Install m.css dependencies
run: pip3 install jinja2 Pygments
- uses: actions/checkout@v4

- name: Install Doxygen
- name: Install deps
run: sudo apt-get update -q
&& sudo apt-get install doxygen -q -y
&& sudo apt-get install doxygen graphviz -q -y

- name: Build docs
run: cmake -B build -D "CMAKE_PROJECT_INCLUDE=$PWD/cmake/docs.cmake"
&& cmake --build build --target docs

- name: Deploy docs
uses: peaceiris/actions-gh-pages@v3
uses: peaceiris/actions-gh-pages@v4
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: build/docs/html
publish_dir: ./docs/html
allow_empty_commit: true

0 comments on commit 1441240

Please sign in to comment.