Run protoplaster in renode during docs generation #21
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: Generate and publish docs | |
| on: | |
| push: | |
| # branches: | |
| # - main | |
| pull_request: | |
| workflow_dispatch: | |
| schedule: | |
| - cron: '0 0 * * 3' | |
| jobs: | |
| docs: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Get repository | |
| uses: actions/checkout@v3 | |
| - uses: actions/setup-python@v2 | |
| with: | |
| python-version: 3.11 | |
| - name: Install protoplaster with pip | |
| run: | | |
| pip install . | |
| - name: Install tuttest | |
| run: | | |
| pip install git+https://github.com/antmicro/tuttest | |
| - name: Generate docs from yml | |
| run: | | |
| tuttest README.md example > example.yml | |
| # - name: Generate test report from yml | |
| # run: | | |
| # protoplaster -t example.yml --csv report.csv | |
| # protoplaster-test-report report.csv -t md | |
| - name: Generate system report from yml | |
| run: | | |
| tuttest README.md system-report-example > system-report-example.yml | |
| - name: Run protoplaster in Renode | |
| uses: antmicro/renode-linux-runner-action@v1 | |
| with: | |
| shared-dirs: ./ | |
| renode-run: | | |
| python -m venv .venv | |
| source .venv/bin/activate | |
| pip install . | |
| protoplaster -t example.yml --generate-docs | |
| protoplaster -t example.yml --csv report.csv | |
| protoplaster-test-report report.csv -t md | |
| protoplaster-system-report -c system-report-example.yml | |
| devices: | | |
| vivid | |
| gpio 0 32 | |
| i2c 0x1C | |
| - name: Prepare docs template | |
| run: | | |
| cp -r .github/docs-template docs/ | |
| cp README.md docs/source/readme.md | |
| cp home/protoplaster.md docs/source/ | |
| cp home/report.md docs/source/ | |
| echo -e "\`\`\`\n$(cat system-report-example.yml)\n\`\`\`" >> docs/source/system-report-example.yml | |
| mkdir -p docs/source/_static/system_report | |
| unzip home/report.zip -d docs/source/_static/system_report | |
| - name: Build html | |
| uses: docker://btdi/sphinx:min | |
| with: | |
| args: ./.github/scripts/sphinx.sh | |
| - name: Build pdf | |
| uses: docker://btdi/latex | |
| with: | |
| args: ./.github/scripts/latex.sh | |
| - name: 'Upload artifact: Sphinx HTML and PDF' | |
| uses: actions/upload-artifact@v3 | |
| with: | |
| name: Documentation | |
| path: docs/build/html | |
| # - name: Deploy | |
| # if: github.ref == 'refs/heads/main' | |
| # run: | | |
| # sudo chown -R $(whoami) docs | |
| # cd docs/build/html | |
| # touch .nojekyll | |
| # git init | |
| # cp ../../../.git/config ./.git/config | |
| # git add . | |
| # git config --local user.email "push@gha" | |
| # git config --local user.name "GHA" | |
| # git commit -am "update ${{ github.sha }}" | |
| # git push -u origin +HEAD:gh-pages | |
| # rm -rf .git |