Skip to content

Commit

Permalink
Merge pull request #753 from jdemel/build-docs-ci
Browse files Browse the repository at this point in the history
docs: Add VOLK doc build to CI
  • Loading branch information
jdemel authored Feb 20, 2024
2 parents aac4c7f + 0c5e922 commit 399699c
Show file tree
Hide file tree
Showing 3 changed files with 578 additions and 242 deletions.
30 changes: 30 additions & 0 deletions .github/workflows/publish_docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
name: Publish docs

on: [push]
jobs:
build-docs:
name: Build VOLK docs
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v3.1.0
with:
submodules: 'recursive'
- name: Install dependencies
run: sudo apt install python3-mako liborc-dev doxygen
- name: Configure
run: mkdir build && cd build && cmake -DCMAKE_CXX_FLAGS="-Werror" -DBUILD_EXECUTABLE=ON ..
- name: Build
run: cmake --build build --target volk_doc
- name: Setup SSH Keys
env:
SSH_AUTH_SOCK: /tmp/ssh_agent.sock
run: |
ssh-agent -a $SSH_AUTH_SOCK > /dev/null
ssh-add - <<< "${{ secrets.SSH_KEY }}"
- name: Upload via SSH
run: 'tar -cz build/html/ | ssh ${{ secrets.SSH_USER }}@${{ secrets.SSH_HOST }} "mkdir -p /www/$(date +%Y.%m.%d); cd /www/$(date +%Y.%m.%d); tar --strip-components=1 -xz; rm /www/live; cd /www; ln -sf $(date +%Y.%m.%d) live;"'
- uses: actions/upload-artifact@v4
with:
name: volk_docs
path: build/html/
4 changes: 4 additions & 0 deletions .github/workflows/run-tests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -189,6 +189,8 @@ jobs:
- name: test
run: cd build && ctest -V



build-windows:

runs-on: windows-latest
Expand Down Expand Up @@ -267,3 +269,5 @@ jobs:
# ./build/apps/volk-config-info --cc
- name: test
run: cd build && ctest -V


Loading

0 comments on commit 399699c

Please sign in to comment.