feat: Add curve query support for MSO2KB series scopes (#269) #5
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: Test docs | |
| on: | |
| push: | |
| branches: [main] | |
| pull_request: | |
| branches: [main] | |
| workflow_call: # In order to use this workflow, the caller must have a tox configuration that includes both a "docs" and "doctests" environment. | |
| inputs: | |
| node-version: | |
| description: The version of Node.js to install. This workflow also installs | |
| mermaid-cli via npm and graphviz via apt. | |
| required: true | |
| type: number | |
| python-version: | |
| description: The version of Python to use for this workflow. | |
| required: true | |
| type: string | |
| # Cancel running jobs for the same workflow and branch. | |
| concurrency: | |
| group: ${{ github.workflow }}-${{ github.ref }} | |
| cancel-in-progress: ${{ github.ref != 'refs/heads/main' }} | |
| # IMPORTANT: Any new jobs need to be added to the check-docs-passed job to ensure they correctly gate code changes | |
| jobs: | |
| test-docs: | |
| runs-on: ubuntu-latest | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| tox_env: [docs, doctests] | |
| env: | |
| NODE_VERSION: ${{ inputs.node-version || 20 }} # The node version needs to stay in sync with .readthedocs.yml | |
| PYTHON_VERSION: ${{ inputs.node-version || '3.11' }} # This needs to stay in sync with .readthedocs.yml and the tox config in pyproject.toml | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: actions/setup-node@v4 | |
| with: | |
| node-version: ${{ env.NODE_VERSION }} | |
| - name: Install non-python documentation dependencies | |
| run: | | |
| npm install --global @mermaid-js/mermaid-cli | |
| sudo apt install --no-install-recommends --assume-yes graphviz | |
| - name: Set up Python | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: ${{ env.PYTHON_VERSION }} | |
| - name: Install tox | |
| run: python -m pip install tox | |
| - name: Test | |
| run: tox -ve ${{ matrix.tox_env }} | |
| - uses: thedoctor0/[email protected] | |
| if: ${{ !cancelled() }} | |
| with: | |
| type: zip | |
| filename: ${{ matrix.tox_env }}_results.zip | |
| path: .results_${{ matrix.tox_env }}/ | |
| - uses: actions/upload-artifact@v4 | |
| if: ${{ !cancelled() }} | |
| with: | |
| name: artifact_${{ matrix.tox_env }} | |
| path: ${{ matrix.tox_env }}_results.zip | |
| # Check that all jobs passed | |
| check-docs-passed: | |
| if: ${{ !cancelled() }} | |
| needs: [test-docs] | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Decide whether the needed jobs succeeded or failed | |
| uses: re-actors/alls-green@release/v1 | |
| with: | |
| jobs: ${{ toJSON(needs) }} |