started writing some tests (yay) #1086
Workflow file for this run
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
name: Build Documentation | |
on: | |
push: | |
# create: | |
# tags: | |
# - v* | |
jobs: | |
release-doc: | |
name: Build and release documentation | |
strategy: | |
matrix: | |
# runs-on: [ ubuntu-20.04, macOS-latest] | |
runs-on: [ ubuntu-20.04 ] | |
fail-fast: false | |
runs-on: ${{ matrix.runs-on }} | |
steps: | |
- uses: actions/checkout@v2 | |
- run: git fetch --depth=1 origin +refs/tags/*:refs/tags/* | |
- run: | | |
git fetch --no-tags --prune --depth=1 origin +refs/heads/*:refs/remotes/origin/* | |
- run: | | |
git fetch --prune --unshallow | |
- name: Cache pip Linux | |
uses: actions/cache@v1 | |
if: startsWith(runner.os, 'Linux') | |
with: | |
path: ~/.cache/pip | |
key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }} | |
restore-keys: | | |
${{ runner.os }}-pip- | |
- name: Cache pip macOS | |
uses: actions/cache@v1 | |
if: startsWith(runner.os, 'macOS') | |
with: | |
path: ~/Library/Caches/pip | |
key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }} | |
restore-keys: | | |
${{ runner.os }}-pip- | |
- name: ccache cache files | |
uses: actions/[email protected] | |
with: | |
path: ${{runner.workspace}}/.ccache | |
key: ${{ runner.OS }}-ccache-${{ steps.ccache_cache_timestamp.outputs.timestamp }} | |
restore-keys: | | |
${{ runner.OS }}-ccache- | |
- name: Install Dependencies | |
run: ./install_dependencies.sh | |
- name: Create Build Environment | |
# Some projects don't allow in-source building, so create a separate build directory | |
# We'll use this as our working directory for all subsequent commands | |
run: cmake -E make_directory ${{runner.workspace}}/build | |
- name: Cache CCache | |
uses: actions/cache@v1 | |
with: | |
path: ~/.ccache | |
# key: ${{ runner.OS }}-build-ccache-${{ hashFiles('**/package-lock.json') }} | |
key: ${{ runner.OS }}-build-ccache | |
restore-keys: | | |
${{ runner.OS }}-build-ccache-${{ env.cache-name }}- | |
${{ runner.OS }}-build-ccache- | |
- name: Configure CMake | |
if: startsWith(runner.os, 'Linux') | |
# Use a bash shell so we can use the same syntax for environment variable | |
# access regardless of the host operating system | |
shell: bash | |
# Note the current convention is to use the -S and -B options here to specify source | |
# and build directories, but this is only available with CMake 3.13 and higher. | |
# The CMake binaries on the Github Actions machines are (as of this writing) 3.12 | |
run: | | |
mkdir -p build/doc | |
cd build | |
export BUILD_TYPE=Debug | |
cp $GITHUB_WORKSPACE/documentation/index.html doc/ | |
$GITHUB_WORKSPACE/tools/genversion.py $GITHUB_WORKSPACE | |
cmake -G Ninja $GITHUB_WORKSPACE -DCMAKE_BUILD_TYPE=$BUILD_TYPE -DBUILD_ALL_PLUGINS=ON -DBUILD_TESTS=ON -DBUILD_COVERAGE=ON -DPL_GUI=ON -DBUILD_DOCUMENTATION=ON -DPACKAGE_DEB=OFF -DCMAKE_INSTALL_PREFIX=/usr/ -DPYBIND11_PYTHON_VERSION=3.6 | |
env: | |
CCACHE_DIR: ${{runner.workspace}}/.ccache | |
CCACHE_COMPRESS: true | |
CCACHE_COMPRESSLEVEL: 6 | |
CCACHE_MAXSIZE: 400M | |
HAL_BASE_PATH: ${{runner.workspace}}/hal/build | |
- name: Build | |
if: startsWith(runner.os, 'Linux') | |
shell: bash | |
# Execute the build. You can specify a specific target with "--target <NAME>" | |
run: | | |
cd build | |
ninja | |
env: | |
CCACHE_DIR: ${{runner.workspace}}/.ccache | |
CCACHE_COMPRESS: true | |
CCACHE_COMPRESSLEVEL: 6 | |
CCACHE_MAXSIZE: 400M | |
HAL_BASE_PATH: ${{runner.workspace}}/hal/build | |
- name: Build Doxygen | |
if: startsWith(runner.os, 'Linux') | |
shell: bash | |
# Execute the build. You can specify a specific target with "--target <NAME>" | |
run: | | |
cd build | |
export BUILD_TYPE=Debug | |
mkdir -p doc/doc | |
cmake --build . --target doc --config $BUILD_TYPE | |
cp -R documentation/cpp-doc/html/* doc/doc/ | |
env: | |
CCACHE_DIR: ${{runner.workspace}}/.ccache | |
CCACHE_COMPRESS: true | |
CCACHE_COMPRESSLEVEL: 6 | |
CCACHE_MAXSIZE: 400M | |
HAL_BASE_PATH: ${{runner.workspace}}/hal/build | |
- name: Build Sphinx | |
if: startsWith(runner.os, 'Linux') | |
shell: bash | |
# Execute the build. You can specify a specific target with "--target <NAME>" | |
run: | | |
cd build | |
export BUILD_TYPE=Debug | |
mkdir -p doc/pydoc | |
cmake --build . --target pydoc --config $BUILD_TYPE | |
cp -R documentation/python-doc/html/* doc/pydoc/ | |
env: | |
CCACHE_DIR: ${{runner.workspace}}/.ccache | |
CCACHE_COMPRESS: true | |
CCACHE_COMPRESSLEVEL: 6 | |
CCACHE_MAXSIZE: 400M | |
HAL_BASE_PATH: ${{runner.workspace}}/hal/build | |
- name: Deploy Doc | |
if: github.ref == 'refs/heads/master' | |
uses: JamesIves/github-pages-deploy-action@releases/v3 | |
with: | |
BRANCH: gh-pages | |
ACCESS_TOKEN: ${{ secrets.GH_PAGES_TOKEN}} | |
FOLDER: build/doc | |
GIT_CONFIG_NAME: 'github-actions[bot]' | |
GIT_CONFIG_EMAIL: 'github-actions[bot]@users.noreply.github.com' |