Feature tutorials #17
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
| # This workflow will run some regression tests. | |
| name: Regression Tests | |
| on: | |
| push: | |
| branches: ['master', 'devel'] | |
| pull_request: | |
| branches: '*' | |
| jobs: | |
| Pytest: | |
| runs-on: ubuntu-latest | |
| strategy: | |
| matrix: | |
| # Add multiple Python versions here to run tests on new(er) versions. | |
| python-version: ["3.10"] | |
| steps: | |
| - uses: actions/checkout@v3 | |
| - name: Set up Python ${{ matrix.python-version }} | |
| uses: actions/setup-python@v3 | |
| with: | |
| python-version: ${{ matrix.python-version }} | |
| - name: Build and install | |
| run: | | |
| python -m pip install --upgrade pip | |
| # Install with -e (in editable mode) to allow the tracking of the test coverage | |
| pip install -e .[test] | |
| - name: Analyse the code with pytest | |
| run: | | |
| # Run the actual testing | |
| pytest -v --basetemp=./tmp --cov=panelaero --junitxml=testresult.xml | |
| # Create some reports | |
| coverage report | |
| coverage xml -o coverage.xml | |
| # Put the html into a 2nd-level sub-folder and use 1st-level subfolder for uploading to maintain folder | |
| coverage html --directory ./coverage | |
| - name: Upload test restults and coverage as an artifact | |
| uses: actions/upload-artifact@v4 | |
| with: | |
| name: test results and coverage | |
| path: | | |
| testresult.xml | |
| coverage.xml | |
| coverage | |
| if-no-files-found: ignore | |
| Jupyter: | |
| # Building the Jupyter book is not really a regression test. However, it has to be in this workflow due to the handling of | |
| # the artifacts. | |
| runs-on: ubuntu-latest | |
| strategy: | |
| matrix: | |
| # Select Python version to be used for compiling here. | |
| python-version: ["3.10"] | |
| steps: | |
| - uses: actions/checkout@v3 | |
| - name: Set up Python ${{ matrix.python-version }} | |
| uses: actions/setup-python@v3 | |
| with: | |
| python-version: ${{ matrix.python-version }} | |
| - name: Install dependencies | |
| run: | | |
| python -m pip install --upgrade pip | |
| # Install the package itself to make sure that all imports work. | |
| pip install .[tutorials] | |
| - name: Assemble the tutorials to a jupyter book and build htlm pages | |
| run: | | |
| jupyter-book build ./doc/tutorials | |
| # Put the html into a 2nd-level sub-folder and use 1st-level subfolder for uploading | |
| mkdir ./doc/html | |
| mv ./doc/tutorials/_build/html ./doc/html/tutorials | |
| - name: Upload Jupyter book as an artifact | |
| uses: actions/upload-artifact@v4 | |
| with: | |
| name: tutorials | |
| path: ./doc/html | |
| if-no-files-found: ignore | |
| combine-pages: | |
| runs-on: ubuntu-latest | |
| # Add a dependency to the build job | |
| needs: [Jupyter, Pytest] | |
| steps: | |
| - uses: actions/download-artifact@v4 | |
| with: | |
| merge-multiple: true | |
| - name: See what we've got and merge artifacts | |
| run: | | |
| ls -la | |
| mkdir pages | |
| mv ./tutorials ./pages/tutorials | |
| mv ./coverage ./pages/coverage | |
| - name: Upload artifact for pages | |
| # This is not a normal artifact but one that can be deployed to the GitHub pages in the next step | |
| uses: actions/upload-pages-artifact@v3 | |
| with: | |
| name: github-pages # This name may not be changed according to the documentation | |
| path: ./pages # There must be only one path | |
| if-no-files-found: ignore | |
| deploy-pages: | |
| # Add a dependency to the build job | |
| needs: combine-pages | |
| # Grant GITHUB_TOKEN the permissions required to make a Pages deployment | |
| permissions: | |
| pages: write # to deploy to Pages | |
| id-token: write # to verify the deployment originates from an appropriate source | |
| # Deploy to the github-pages environment | |
| environment: | |
| name: github-pages | |
| url: ${{ steps.deployment.outputs.page_url }} | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Setup GitHub Pages | |
| uses: actions/configure-pages@v4 | |
| - name: Deploy to Pages | |
| id: deployment | |
| uses: actions/deploy-pages@v4 |