Implement jobs to build and deploy docs #60
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: CI | |
| on: | |
| pull_request: | |
| push: | |
| tags: | |
| - "*" | |
| branches: | |
| - main | |
| env: | |
| MAIN_PYTHON_VERSION : '3.10' | |
| LIBRARY_NAME: 'ansys-rocky-core' | |
| DOCUMENTATION_CNAME: 'rocky.docs.pyansys.com' | |
| DOC_DEPLOYMENT_IMAGE_TAG: v24.1.0 | |
| concurrency: | |
| group: ${{ github.workflow }}-${{ github.ref }} | |
| cancel-in-progress: true | |
| jobs: | |
| tests: | |
| name: Tests | |
| runs-on: [self-hosted, Windows, pyrocky] | |
| timeout-minutes: 10 | |
| env: | |
| ANSYSLMD_LICENSE_FILE: 1055@${{ secrets.LICENSE_SERVER }} | |
| steps: | |
| - uses: actions/checkout@v3 | |
| - name: "Install" | |
| run: | | |
| python -m venv .venv | |
| .venv/Scripts/activate.bat | |
| pip install -e .[dev] | |
| - name: "Test" | |
| run: | | |
| .venv/Scripts/activate.bat | |
| pre-commit run --all-files --show-diff-on-failure | |
| pytest tests --junitxml=build/pytest.xml | |
| - name: "Check Examples" | |
| run: | | |
| .venv/Scripts/activate.bat | |
| python run_examples.py | |
| - name: Test Report | |
| uses: dorny/test-reporter@v1 | |
| if: success() || failure() # run this step even if previous step failed | |
| with: | |
| name: Pytest Report | |
| path: build/pytest.xml # Path to test results | |
| reporter: java-junit | |
| docs_build: | |
| name: Build Documentation | |
| runs-on: [self-hosted, Windows, pyrocky] | |
| env: | |
| ANSYSLMD_LICENSE_FILE: 1055@${{ secrets.LICENSE_SERVER }} | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: "Install" | |
| run: | | |
| python -m venv .venv | |
| .venv/Scripts/activate.bat | |
| pip install -e .[dev] | |
| - name: Build Source Documentation | |
| run: | | |
| .venv/Scripts/activate.bat | |
| cd doc | |
| .\make.bat html | |
| - name: Zip HTML Documentation before upload | |
| run: | | |
| cd doc\_build\html | |
| Compress-Archive * ../../../HTML-Documentation-tag-${{ env.DOC_DEPLOYMENT_IMAGE_TAG }}.zip | |
| - name: Upload HTML Documentation | |
| uses: actions/upload-artifact@v3 | |
| with: | |
| name: HTML-Documentation-tag-${{ env.DOC_DEPLOYMENT_IMAGE_TAG }} | |
| path: HTML-Documentation-tag-${{ env.DOC_DEPLOYMENT_IMAGE_TAG }}.zip | |
| retention-days: 7 | |
| doc-deploy-dev: | |
| name: "Deploy development documentation" | |
| # Deploy development only when merging or pushing to the 'main' branch | |
| if: github.event_name == 'push' && !contains(github.ref, 'refs/tags') | |
| runs-on: ubuntu-latest | |
| needs: docs_build | |
| steps: | |
| - uses: ansys/actions/doc-deploy-dev@v4 | |
| with: | |
| doc-artifact-name: 'HTML-Documentation-tag-${{ env.DOC_DEPLOYMENT_IMAGE_TAG }}' | |
| decompress-artifact: true | |
| cname: ${{ env.DOCUMENTATION_CNAME }} | |
| token: ${{ secrets.GITHUB_TOKEN }} |