FEAT: Updates docs with autoapi #716
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: GitHub CI | |
| on: | |
| workflow_dispatch: | |
| pull_request: | |
| push: | |
| tags: | |
| - "*" | |
| branches: | |
| - main | |
| env: | |
| MAIN_PYTHON_VERSION: '3.10' | |
| PACKAGE_NAME: 'ansys-tools-path' | |
| PACKAGE_NAMESPACE: 'ansys.tools.path' | |
| DOCUMENTATION_CNAME: 'path.tools.docs.pyansys.com' | |
| concurrency: | |
| group: ${{ github.workflow }}-${{ github.ref }} | |
| cancel-in-progress: true | |
| jobs: | |
| smoke-tests: | |
| name: "Build and smoke tests" | |
| runs-on: ${{ matrix.os }} | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| os: [ubuntu-latest, windows-latest, macos-latest] | |
| python-version: ['3.10', '3.11', '3.12'] | |
| # Only perform wheelhouse builds for macOS when releasing | |
| should-release: | |
| - ${{ github.event_name == 'push' && contains(github.ref, 'refs/tags') }} | |
| exclude: | |
| - should-release: false | |
| os: macos-latest | |
| steps: | |
| - name: "Build wheelhouse and perform smoke test" | |
| uses: ansys/actions/build-wheelhouse@v8 | |
| with: | |
| library-name: ${{ env.PACKAGE_NAME }} | |
| library-namespace: ${{ env.PACKAGE_NAMESPACE }} | |
| operating-system: ${{ matrix.os }} | |
| python-version: ${{ matrix.python-version }} | |
| build-tests: | |
| name: Build and Testing | |
| runs-on: ubuntu-latest | |
| needs: [smoke-tests] | |
| container: | |
| image: ghcr.io/ansys/pymapdl/mapdl:v22.2-ubuntu | |
| options: "-u=0:0 --entrypoint /bin/bash" | |
| credentials: | |
| username: ${{ secrets.GH_USERNAME }} | |
| password: ${{ secrets.GITHUB_TOKEN }} | |
| env: | |
| ANSYS_LOCAL: true | |
| ON_UBUNTU: true | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Setup Python | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: ${{ env.MAIN_PYTHON_VERSION }} | |
| - name: Install library, with test extra | |
| run: python -m pip install .[tests] | |
| - name: Unit testing | |
| run: | | |
| python -m pytest -vx --cov=${{ env.PACKAGE_NAMESPACE }} --cov-report=term --cov-report=xml:.cov/coverage.xml --cov-report=html:.cov/html | |
| - name: Upload coverage reports to Codecov | |
| uses: codecov/codecov-action@v5 | |
| with: | |
| files: .cov/coverage.xml | |
| docs-style: | |
| name: Documentation style check | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Ansys documentation style checks | |
| uses: ansys/actions/doc-style@v8 | |
| with: | |
| token: ${{ secrets.GITHUB_TOKEN }} | |
| docs: | |
| name: Documentation | |
| runs-on: ubuntu-latest | |
| needs: [docs-style] | |
| steps: | |
| - name: "Run Ansys documentation building action" | |
| uses: ansys/actions/doc-build@v8 | |
| with: | |
| python-version: ${{ env.MAIN_PYTHON_VERSION }} | |
| dependencies: "build-essential zip pandoc texlive-latex-extra latexmk texlive-pstricks" | |
| package: | |
| name: Package library | |
| needs: [build-tests, docs] | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Build library source and wheel artifacts | |
| uses: ansys/actions/build-library@v8 | |
| with: | |
| library-name: ${{ env.PACKAGE_NAME }} | |
| python-version: ${{ env.MAIN_PYTHON_VERSION }} | |
| release: | |
| name: Release project | |
| if: ${{ github.event_name == 'push' && contains(github.ref, 'refs/tags') }} | |
| needs: [package] | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Release to the public PyPI repository | |
| uses: ansys/actions/release-pypi-public@v8 | |
| with: | |
| library-name: ${{ env.PACKAGE_NAME }} | |
| twine-username: "__token__" | |
| twine-token: ${{ secrets.PYPI_TOKEN }} | |
| - name: Release to GitHub | |
| uses: ansys/actions/release-github@v8 | |
| with: | |
| library-name: ${{ env.PACKAGE_NAME }} | |
| upload_docs_dev: | |
| name: Upload dev documentation | |
| if: ${{ github.ref == 'refs/heads/main' }} | |
| runs-on: ubuntu-latest | |
| needs: [package] | |
| steps: | |
| - name: Deploy the latest documentation | |
| uses: ansys/actions/doc-deploy-dev@v8 | |
| with: | |
| cname: ${{ env.DOCUMENTATION_CNAME }} | |
| token: ${{ secrets.PYANSYS_CI_BOT_TOKEN }} | |
| bot-user: ${{ secrets.PYANSYS_CI_BOT_USERNAME }} | |
| bot-email: ${{ secrets.PYANSYS_CI_BOT_EMAIL }} | |
| python-version: ${{ env.MAIN_PYTHON_VERSION }} | |
| upload_docs_release: | |
| name: Upload release documentation | |
| if: ${{ github.event_name == 'push' && contains(github.ref, 'refs/tags') }} | |
| runs-on: ubuntu-latest | |
| needs: [release] | |
| steps: | |
| - name: Deploy the stable documentation | |
| uses: ansys/actions/doc-deploy-stable@v8 | |
| with: | |
| cname: ${{ env.DOCUMENTATION_CNAME }} | |
| token: ${{ secrets.PYANSYS_CI_BOT_TOKEN }} | |
| bot-user: ${{ secrets.PYANSYS_CI_BOT_USERNAME }} | |
| bot-email: ${{ secrets.PYANSYS_CI_BOT_EMAIL }} | |
| python-version: ${{ env.MAIN_PYTHON_VERSION }} |