FIX: follow pyansys repo guidelines (#361) #896
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: | |
| pull_request: | |
| push: | |
| tags: | |
| - '*' | |
| branches: | |
| - release-* | |
| - main | |
| workflow_dispatch: | |
| env: | |
| PACKAGE_NAME: 'ansys-edb-core' | |
| DOCUMENTATION_CNAME: 'edb.core.docs.pyansys.com' | |
| MAIN_PYTHON_VERSION: '3.10' | |
| concurrency: | |
| group: ${{ github.workflow }}-${{ github.ref }} | |
| cancel-in-progress: true | |
| jobs: | |
| style: | |
| name: Code style | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: PyAnsys code style checks | |
| uses: ansys/actions/code-style@v4 | |
| with: | |
| python-version: ${{ env.MAIN_PYTHON_VERSION }} | |
| doc-style: | |
| name: Documentation Style Check | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: PyAnsys documentation style checks | |
| uses: ansys/actions/doc-style@v5 | |
| with: | |
| token: ${{ secrets.GITHUB_TOKEN }} | |
| smoke-tests: | |
| name: Build and Smoke tests | |
| runs-on: ${{ matrix.os }} | |
| needs: [style] | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| os: [windows-latest, ubuntu-latest] | |
| python-version: ['3.8', '3.9', '3.10'] | |
| steps: | |
| - name: Build wheelhouse and perform smoke test | |
| uses: ansys/actions/build-wheelhouse@v5 | |
| with: | |
| library-name: ${{ env.PACKAGE_NAME }} | |
| operating-system: ${{ matrix.os }} | |
| python-version: ${{ matrix.python-version }} | |
| tests: | |
| name: Tests and coverage | |
| runs-on: ${{ matrix.os }} | |
| strategy: | |
| matrix: | |
| os: [windows-latest, ubuntu-latest] | |
| python-version: ['3.8', '3.9', '3.10'] | |
| fail-fast: false | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Set up Python ${{ matrix.python-version }} | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: ${{ matrix.python-version }} | |
| - name: Install dependencies | |
| run: | | |
| python -m pip install --upgrade .[tests] | |
| python -m pip install --upgrade tox-gh-actions | |
| - name: Test with tox | |
| # Only the tox environment specified in the tox.ini gh-actions is run | |
| run: tox -e test -- --ignore=tests/e2e | |
| doc-build: | |
| name: "Doc build" | |
| runs-on: ubuntu-latest | |
| needs: doc-style | |
| steps: | |
| - name: "Build documentation" | |
| uses: ansys/actions/doc-build@main | |
| with: | |
| skip-install: true | |
| python-version: ${{ env.MAIN_PYTHON_VERSION }} | |
| use-python-cache: false | |
| sphinxopts: '-j auto -w build_errors.txt -N -q' | |
| package: | |
| name: Package library | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Build library source and wheel artifacts | |
| uses: ansys/actions/build-library@v5 | |
| 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, tests, doc-build] | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Release to the public PyPI repository | |
| uses: ansys/actions/release-pypi-public@v5 | |
| with: | |
| library-name: ${{ env.PACKAGE_NAME }} | |
| twine-username: "__token__" | |
| twine-token: ${{ secrets.PYPI_TOKEN }} | |
| - name: Release to GitHub | |
| uses: ansys/actions/release-github@v5 | |
| with: | |
| library-name: ${{ env.PACKAGE_NAME }} | |
| 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: [package, tests, doc-build] | |
| steps: | |
| - uses: ansys/actions/doc-deploy-dev@v5 | |
| with: | |
| cname: ${{ env.DOCUMENTATION_CNAME }} | |
| token: ${{ secrets.GITHUB_TOKEN }} | |
| doc-artifact-name: documentation-html | |
| doc-deploy-stable: | |
| name: "Deploy stable documentation" | |
| # Deploy release documentation when creating a new tag | |
| if: github.event_name == 'push' && contains(github.ref, 'refs/tags') | |
| runs-on: ubuntu-latest | |
| needs: release | |
| steps: | |
| - uses: ansys/actions/doc-deploy-stable@v5 | |
| with: | |
| cname: ${{ env.DOCUMENTATION_CNAME }} | |
| token: ${{ secrets.GITHUB_TOKEN }} | |
| doc-artifact-name: documentation-html | |