Fix CTAO link in docs #4966
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: | |
| push: | |
| branches: | |
| - main | |
| tags: | |
| - "**" | |
| pull_request: | |
| env: | |
| NUMBA_NUM_THREADS: 1 | |
| OMP_NUM_THREADS: 1 | |
| MKL_NUM_THREADS: 1 | |
| MPLBACKEND: Agg | |
| PYTEST_ADDOPTS: --color=yes | |
| GITHUB_PR_NUMBER: ${{ github.event.number }} | |
| jobs: | |
| lint: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| with: | |
| fetch-depth: 0 | |
| - uses: actions/setup-python@v5 | |
| with: | |
| python-version: "3.10" | |
| - name: Check README syntax | |
| run: | | |
| pip install restructuredtext-lint | |
| restructuredtext-lint README.rst | |
| - uses: pre-commit/[email protected] | |
| with: | |
| extra_args: --files $(git diff origin/main --name-only) | |
| tests: | |
| runs-on: ${{ matrix.os }} | |
| needs: lint | |
| strategy: | |
| matrix: | |
| include: | |
| - name: Linux (3.10, mamba) | |
| os: ubuntu-latest | |
| python-version: "3.10" | |
| install-method: mamba | |
| extras: tests,all | |
| - name: Linux (3.10, pip) | |
| os: ubuntu-latest | |
| python-version: "3.10" | |
| install-method: pip | |
| extras: tests,all | |
| - name: Linux (3.11, pip, minimal-dependencies) | |
| os: ubuntu-latest | |
| python-version: "3.11" | |
| install-method: pip | |
| extras: tests | |
| - name: Linux (3.12, mamba, coverage) | |
| os: ubuntu-latest | |
| python-version: "3.12" | |
| install-method: mamba | |
| extra-args: ["codecov"] | |
| extras: tests,all | |
| - name: Linux (3.12, pip) | |
| os: ubuntu-latest | |
| python-version: "3.12" | |
| install-method: pip | |
| extras: tests,all | |
| # macos 13 image is x86-based | |
| - name: macos (3.10, x86_64, pip) | |
| os: macos-13 | |
| python-version: "3.10" | |
| install-method: pip | |
| extras: tests,all | |
| # macos 14 image is arm64 based | |
| - name: macos (3.12, arm64, mamba) | |
| os: macos-14 | |
| python-version: "3.12" | |
| install-method: mamba | |
| extras: tests,all | |
| defaults: | |
| run: | |
| # We need login shells (-l) for micromamba to work. | |
| shell: bash -leo pipefail {0} | |
| steps: | |
| - uses: actions/checkout@v4 | |
| with: | |
| fetch-depth: 0 | |
| - name: cache test data | |
| uses: actions/cache@v4 | |
| with: | |
| path: ~/.cache/ctapipe | |
| key: ctapipe-test-data | |
| - name: Prepare mamba installation | |
| if: matrix.install-method == 'mamba' && contains(github.event.pull_request.labels.*.name, 'documentation-only') == false | |
| env: | |
| PYTHON_VERSION: ${{ matrix.python-version }} | |
| run: | | |
| # setup correct python version | |
| sed -i -e "s/- python=.*/- python=$PYTHON_VERSION/g" environment.yml | |
| - name: mamba setup | |
| if: matrix.install-method == 'mamba' && contains(github.event.pull_request.labels.*.name, 'documentation-only') == false | |
| uses: mamba-org/setup-micromamba@v2 | |
| with: | |
| environment-file: environment.yml | |
| cache-downloads: true | |
| - name: Python setup | |
| if: matrix.install-method == 'pip' && contains(github.event.pull_request.labels.*.name, 'documentation-only') == false | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: ${{ matrix.python-version }} | |
| check-latest: true | |
| - if: matrix.install-method == 'pip' && runner.os == 'macOS' && contains(github.event.pull_request.labels.*.name, 'documentation-only') == false | |
| name: Fix Python PATH on macOS | |
| # See https://github.com/actions/setup-python/issues/132 and | |
| # https://github.com/actions/setup-python/issues/132#issuecomment-779406058 | |
| # Login shells on macOS prepend system paths, so we need to | |
| # prepend the python path from actions/setup-python. | |
| # Micromamba sets up ~/.bash_profile, where we need to set the path now. | |
| run: | | |
| tee -a ~/.bash_profile <<<'export PATH="$pythonLocation/bin:$PATH"' | |
| - name: Install dependencies | |
| if: contains(github.event.pull_request.labels.*.name, 'documentation-only') == false | |
| env: | |
| PYTHON_VERSION: ${{ matrix.python-version }} | |
| EXTRAS: ${{ matrix.extras }} | |
| run: | | |
| python --version | grep "Python ${PYTHON_VERSION}" | |
| pip install -e ".[${EXTRAS}]" | |
| pip install ./test_plugin | |
| pip freeze | |
| pip list | |
| - name: ctapipe-info | |
| if: contains(github.event.pull_request.labels.*.name, 'documentation-only') == false | |
| run: | | |
| ctapipe-info --all | |
| - name: Tests | |
| if: contains(github.event.pull_request.labels.*.name, 'documentation-only') == false | |
| run: | | |
| pytest -n auto --dist loadscope \ | |
| --cov --cov-report=xml \ | |
| --doctest-modules --doctest-glob='*.rst' \ | |
| --ignore=docs/conf.py \ | |
| src/ctapipe docs | |
| ctapipe-info --version | |
| - name: Store info for sonar | |
| env: | |
| REF_NAME: ${{ github.ref_name }} | |
| REF_TYPE: ${{ github.ref_type }} | |
| PR_NUMBER: ${{ github.event.pull_request.number }} | |
| SOURCE_REPOSITORY: ${{ github.event.pull_request.head.repo.full_name }} | |
| SOURCE_BRANCH: ${{ github.event.pull_request.head.ref }} | |
| TARGET_BRANCH: ${{ github.event.pull_request.base.ref }} | |
| run: | | |
| echo "PR_NUMBER=${PR_NUMBER}" >> sonar_env | |
| echo "SOURCE_REPOSITORY=${SOURCE_REPOSITORY}" >> sonar_env | |
| echo "SOURCE_BRANCH=${SOURCE_BRANCH}" >> sonar_env | |
| echo "TARGET_BRANCH=${TARGET_BRANCH}" >> sonar_env | |
| cat sonar_env | |
| # upload coverage report for sonar workflow | |
| - uses: actions/upload-artifact@v4 | |
| if: contains(matrix.extra-args, 'codecov') && contains(github.event.pull_request.labels.*.name, 'documentation-only') == false | |
| with: | |
| name: ctapipe-coverage-report | |
| path: | | |
| coverage.xml | |
| sonar_env | |
| docs: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| with: | |
| fetch-depth: 0 | |
| - name: Set up Python | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: "3.10" | |
| - name: Install doc dependencies | |
| run: | | |
| sudo apt update --yes && sudo apt install --yes git build-essential pandoc graphviz ffmpeg | |
| pip install -U pip towncrier setuptools | |
| pip install -e .[docs] | |
| pip install ./test_plugin | |
| git describe --tags | |
| python -c 'import ctapipe; print(ctapipe.__version__)' | |
| - name: Produce Changelog | |
| run: | | |
| towncrier build --yes | |
| - name: Build docs | |
| run: make doc |