Overall doc review #62
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" | |
| DOCUMENTATION_CNAME: "simai.docs.pyansys.com" | |
| LIBRARY_NAME: "ansys-simai-core" | |
| concurrency: | |
| group: ${{ github.workflow }}-${{ github.ref }} | |
| cancel-in-progress: true | |
| jobs: | |
| code-style: | |
| name: "Code style" | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: ansys/actions/code-style@v5 | |
| with: | |
| python-version: ${{ env.MAIN_PYTHON_VERSION }} | |
| doc-style: | |
| name: "Documentation style" | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: ansys/actions/doc-style@v5 | |
| with: | |
| token: ${{ secrets.GITHUB_TOKEN }} | |
| smoke-tests: | |
| name: "Build and Smoke tests" | |
| runs-on: ${{ matrix.os }} | |
| needs: [code-style] | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| os: [ubuntu-latest, windows-latest] | |
| python-version: ["3.9", "3.10", "3.11", "3.12"] | |
| steps: | |
| - uses: ansys/actions/build-wheelhouse@v5 | |
| with: | |
| library-name: ${{ env.LIBRARY_NAME }} | |
| operating-system: ${{ matrix.os }} | |
| python-version: ${{ matrix.python-version }} | |
| tests: | |
| name: "Test using Python ${{ matrix.python-version }}" | |
| runs-on: ${{ matrix.os }} | |
| needs: [smoke-tests] | |
| strategy: | |
| matrix: | |
| os: [ubuntu-latest, windows-latest] | |
| python-version: ["3.9", "3.10", "3.11", "3.12"] | |
| fail-fast: false | |
| steps: | |
| - name: Setup PDM | |
| uses: pdm-project/setup-pdm@v3 | |
| - uses: actions/checkout@v4 | |
| - name: Install dependencies | |
| run: pdm install --dev | |
| - name: Generate test requirements | |
| run: mkdir requirements && pdm export -G test --no-default -o requirements/requirements_tests.txt | |
| - uses: ansys/actions/tests-pytest@v5 | |
| with: | |
| pytest-extra-args: "--cov=ansys --cov-report=term --cov-report=html:.cov/html" | |
| checkout: false | |
| doc-build: | |
| name: "Build documentation" | |
| runs-on: ubuntu-latest | |
| needs: [doc-style] | |
| steps: | |
| - name: Setup PDM | |
| uses: pdm-project/setup-pdm@v3 | |
| - uses: actions/checkout@v4 | |
| - name: Generate doc requirements | |
| run: pdm export -G doc --no-default -o doc_requirements.txt | |
| - uses: ansys/actions/doc-build@v5 | |
| with: | |
| python-version: ${{ env.MAIN_PYTHON_VERSION }} | |
| checkout: false | |
| check-links: false | |
| requirements-file: doc_requirements.txt | |
| build-library: | |
| name: "Build library basic example" | |
| runs-on: ubuntu-latest | |
| needs: [doc-build, tests] | |
| steps: | |
| - uses: ansys/actions/build-library@v5 | |
| with: | |
| library-name: ${{ env.LIBRARY_NAME }} | |
| python-version: ${{ env.MAIN_PYTHON_VERSION }} | |
| doc-deploy-dev: | |
| name: "Deploy development documentation" | |
| runs-on: ubuntu-latest | |
| needs: [build-library] | |
| if: github.event_name == 'push' && !contains(github.ref, 'refs/tags') | |
| steps: | |
| - uses: ansys/actions/doc-deploy-dev@v5 | |
| with: | |
| cname: ${{ env.DOCUMENTATION_CNAME }} | |
| token: ${{ secrets.GITHUB_TOKEN }} | |
| doc-deploy-stable: | |
| name: "Deploy stable documentation" | |
| runs-on: ubuntu-latest | |
| needs: [build-library] | |
| if: github.event_name == 'push' && contains(github.ref, 'refs/tags') | |
| steps: | |
| - uses: ansys/actions/doc-deploy-stable@v5 | |
| with: | |
| cname: ${{ env.DOCUMENTATION_CNAME }} | |
| token: ${{ secrets.GITHUB_TOKEN }} | |
| release: | |
| name: "Release to private and public PyPI and to GitHub" | |
| if: github.event_name == 'push' && contains(github.ref, 'refs/tags') | |
| runs-on: ubuntu-latest | |
| needs: [build-library] | |
| steps: | |
| - name: "Release to the private PyPI repository" | |
| uses: ansys/actions/release-pypi-private@v5 | |
| with: | |
| library-name: ${{ env.LIBRARY_NAME }} | |
| twine-username: "__token__" | |
| twine-token: ${{ secrets.PYANSYS_PYPI_PRIVATE_PAT }} | |
| # - name: "Release to the public PyPI repository" | |
| # uses: ansys/actions/release-pypi-public@v5 | |
| # with: | |
| # library-name: ${{ env.LIBRARY_NAME }} | |
| # twine-username: "__token__" | |
| # twine-token: ${{ secrets.PYPI_TOKEN }} | |
| - name: "Release to GitHub" | |
| uses: ansys/actions/release-github@v5 | |
| with: | |
| library-name: ${{ env.LIBRARY_NAME }} |