Update documentation #550
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: Standard Build Check | |
| on: | |
| push: | |
| pull_request: | |
| workflow_dispatch: | |
| jobs: | |
| buildtest: | |
| name: Build Test | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| with: | |
| submodules: true | |
| - name: Install pyenv | |
| run: | | |
| # Needed for using exact python version, which is | |
| # required in `Pipfile`. | |
| # Make sure it is aligned with vss-tools/Pipfile | |
| curl https://pyenv.run | bash | |
| export PATH="$HOME/.pyenv/bin:$PATH" | |
| pyenv install 3.10.6 | |
| - name: Install vss-tools dependencies | |
| run: | | |
| python -V | |
| python -m pip --quiet --no-input install --upgrade pip | |
| python -m pip --quiet --no-input install --upgrade pipenv wheel | |
| pipenv --version | |
| pipenv run python --version | |
| cd vss-tools | |
| sudo apt install -y protobuf-compiler | |
| pipenv install | |
| echo done! | |
| pipenv run python setup.py install | |
| env: | |
| PIPENV_VENV_IN_PROJECT: 1 | |
| - name: Test mandatory targets | |
| run: | | |
| pipenv install | |
| pipenv run make mandatory_targets | |
| env: | |
| PIPENV_PIPFILE: ./vss-tools/Pipfile | |
| PIPENV_VENV_IN_PROJECT: 1 | |
| - name: Test that ddsidl is correct | |
| run: | | |
| # Ignore vss-tools Pipfile for this use-case | |
| pipenv install --ignore-pipfile cyclonedds | |
| pipenv run idlc *.idl | |
| env: | |
| PIPENV_VENV_IN_PROJECT: 1 | |
| - name: Test optional targets. NOTE - always succeeds | |
| run: | | |
| pipenv install | |
| pipenv run make -k optional_targets || true | |
| env: | |
| PIPENV_PIPFILE: ./vss-tools/Pipfile | |
| PIPENV_VENV_IN_PROJECT: 1 | |
| - name: Install hugo | |
| env: | |
| HUGO_VER : 0.103.1 | |
| run: | | |
| curl -LO https://github.com/gohugoio/hugo/releases/download/v${HUGO_VER}/hugo_${HUGO_VER}_linux-amd64.deb | |
| sudo dpkg -i hugo_${HUGO_VER}_linux-amd64.deb | |
| - name: Make docs | |
| run: | | |
| hugo -s ./docs-gen | |
| - name: Deploy docs | |
| # Only deploy docs if this was a push to master | |
| if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/master' }} | |
| uses: JamesIves/github-pages-deploy-action@v4 | |
| with: | |
| branch: gh-pages # The branch the action should deploy to. | |
| folder: docs # The folder the action should deploy. | |
| commit-message: Auto-deploy docs built from commit ${{ github.sha }} |