Basic e mag example review #1222
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' | |
| LIBRARY_NAME: ansys-motorcad-core | |
| LIBRARY_NAMESPACE: 'ansys.motorcad.core' | |
| CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }} | |
| DOCUMENTATION_CNAME: 'motorcad.docs.pyansys.com' | |
| concurrency: | |
| group: ${{ github.workflow }}-${{ github.ref }} | |
| cancel-in-progress: true | |
| jobs: | |
| style: | |
| name: Code style | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Ansys code style checks | |
| uses: ansys/actions/code-style@v6 | |
| with: | |
| python-version: ${{ env.MAIN_PYTHON_VERSION }} | |
| doc-style: | |
| name: Documentation Style Check | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Ansys documentation style checks | |
| uses: ansys/actions/doc-style@v6 | |
| 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] | |
| python-version: ['3.8', '3.9', '3.10', '3.11'] | |
| steps: | |
| - name: Build wheelhouse and perform smoke test | |
| uses: ansys/actions/build-wheelhouse@v6 | |
| with: | |
| library-name: ${{ env.LIBRARY_NAME }} | |
| library-namespace: ${{ env.LIBRARY_NAMESPACE }} | |
| operating-system: ${{ matrix.os }} | |
| python-version: ${{ matrix.python-version }} | |
| check-licenses: false | |
| tests: | |
| name: Tests and coverage | |
| needs: smoke-tests | |
| runs-on: [self-hosted, pymotorcad, tests] | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Set up Python ${{ env.MAIN_PYTHON_VERSION }} | |
| uses: actions/setup-python@v4 | |
| with: | |
| python-version: ${{ env.MAIN_PYTHON_VERSION }} | |
| - name: Install dependencies | |
| run: | | |
| python -m pip install --upgrade pip tox tox-gh-actions | |
| - name: Test with tox | |
| # Only the tox environment specified in the tox.ini gh-actions is run | |
| run: tox -e py310-coverage | |
| - uses: codecov/codecov-action@v4 | |
| name: 'Upload coverage to Codecov' | |
| doc-build: | |
| name: "Building library documentation" | |
| runs-on: [self-hosted, pymotorcad, docs] | |
| needs: doc-style | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Set up Python ${{ env.MAIN_PYTHON_VERSION }} | |
| uses: actions/setup-python@v4 | |
| with: | |
| python-version: ${{ env.MAIN_PYTHON_VERSION }} | |
| - name: Install dependencies | |
| run: | | |
| python -m pip install --upgrade pip tox tox-gh-actions | |
| - name: Generate the documentation with tox | |
| run: tox -e doc | |
| - name: Upload HTML documentation | |
| uses: actions/upload-artifact@v4 | |
| with: | |
| name: documentation-html | |
| path: .tox/doc_out/ | |
| retention-days: 7 | |
| doc-deploy-development: | |
| name: "Deploy development documentation" | |
| runs-on: ubuntu-latest | |
| if: ${{ github.ref == 'refs/heads/main' }} | |
| needs: package | |
| steps: | |
| - name: "Deploy development documentation" | |
| uses: ansys/actions/doc-deploy-dev@v6 | |
| with: | |
| cname: ${{ env.DOCUMENTATION_CNAME }} | |
| token: ${{ secrets.GITHUB_TOKEN }} | |
| doc-deploy-stable: | |
| name: Doc stable version deploy | |
| if: github.event_name == 'push' && contains(github.ref, 'refs/tags') | |
| runs-on: ubuntu-latest | |
| needs: release | |
| steps: | |
| - name: "Deploy stable documentation" | |
| uses: ansys/actions/doc-deploy-stable@v6 | |
| with: | |
| cname: ${{ env.DOCUMENTATION_CNAME }} | |
| token: ${{ secrets.GITHUB_TOKEN }} | |
| python-version: ${{ env.MAIN_PYTHON_VERSION }} | |
| package: | |
| name: Package library | |
| runs-on: ubuntu-latest | |
| needs: [doc-build, tests] | |
| steps: | |
| - name: Build library source and wheel artifacts | |
| uses: ansys/actions/build-library@v6 | |
| with: | |
| library-name: ${{ env.LIBRARY_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 PyPI repository | |
| uses: ansys/actions/release-pypi-public@v6 | |
| with: | |
| library-name: ${{ env.LIBRARY_NAME }} | |
| twine-username: __token__ | |
| twine-token: ${{ secrets.PYPI_TOKEN }} | |
| - uses: actions/checkout@v4 | |
| - uses: actions/download-artifact@v4 | |
| - name: Display structure of downloaded files | |
| run: ls -R | |
| - name: "Release to GitHub" | |
| uses: softprops/action-gh-release@v2 | |
| with: | |
| files: | | |
| ./**/*.whl | |
| ./**/*.tar.gz | |
| documentation-html |