refactor docs with github actions #1344
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: tests | |
| on: | |
| push: | |
| branches: | |
| - master | |
| pull_request: | |
| pull_request_target: | |
| schedule: | |
| - cron: "42 7 * * 0" # Every Sunday morning when I am fast asleep :) | |
| # This is useful for keeping the cache fit and ready | |
| workflow_dispatch: | |
| jobs: | |
| linting: | |
| name: linting/formatting | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Install uv | |
| uses: astral-sh/setup-uv@v5 | |
| with: | |
| enable-cache: true | |
| - name: Set up Python | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: 3.12 | |
| - name: Ubuntu system dependencies | |
| run: | | |
| sudo apt update | |
| sudo apt install -y libgdal-dev libgeos-dev libproj-dev proj-bin proj-data | |
| - name: Install the project | |
| run: | | |
| uv sync --dev --all-extras | |
| - name: Style checking | |
| run: | | |
| uv run ruff check src tests | |
| uv run ruff format --check src tests | |
| - name: Type checking | |
| run: uv run mypy src tests | |
| tests_fast: | |
| name: (fast) python-${{ matrix.python-version }} on ${{ matrix.os }} | |
| runs-on: ${{ matrix.os }} | |
| strategy: | |
| matrix: | |
| os: | |
| - ubuntu-latest | |
| - windows-latest | |
| - macos-latest | |
| python-version: | |
| - "3.10" | |
| - "3.11" | |
| - "3.12" | |
| - "3.13" | |
| fail-fast: false | |
| env: | |
| PYTHON_VERSION: ${{ matrix.python-version }} | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Install uv | |
| uses: astral-sh/setup-uv@v5 | |
| with: | |
| enable-cache: true | |
| - name: Set up Python | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: ${{ matrix.python-version }} | |
| - name: Cache folder for traffic | |
| uses: actions/cache@v4 | |
| id: cache-folder | |
| with: | |
| path: | | |
| ~/.cache/traffic/ | |
| key: traffic-${{ hashFiles('uv.lock') }} | |
| - name: Ubuntu system dependencies | |
| run: | | |
| sudo apt update | |
| sudo apt install -y libgdal-dev libgeos-dev libproj-dev proj-bin proj-data | |
| - name: Install project | |
| run: | | |
| uv sync --dev --all-extras | |
| - name: Run tests | |
| env: | |
| LD_LIBRARY_PATH: /usr/local/lib | |
| TRAFFIC_NM_PATH: "" | |
| run: | | |
| uv run traffic cache --fill # download files to have in cache first | |
| uv run pytest -m "slow and extra" | |
| tests_full: | |
| name: (full) python-${{ matrix.python-version }} on ${{ matrix.os }} | |
| runs-on: ${{ matrix.os }} | |
| if: ${{ github.event_name != 'pull_request_target' }} | |
| strategy: | |
| matrix: | |
| os: | |
| - ubuntu-latest | |
| #- windows-latest | |
| #- macos-latest | |
| python-version: | |
| - "3.10" | |
| - "3.11" | |
| - "3.12" | |
| - "3.13" | |
| fail-fast: false | |
| env: | |
| PYTHON_VERSION: ${{ matrix.python-version }} | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - run: | | |
| git fetch --prune --unshallow --tags | |
| - name: Install uv | |
| uses: astral-sh/setup-uv@v5 | |
| with: | |
| enable-cache: true | |
| - name: Set up Python | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: ${{ matrix.python-version }} | |
| - name: Download extra data from private repository | |
| uses: actions/checkout@v4 | |
| with: | |
| repository: xoolive/traffic_data | |
| token: ${{ secrets.PRIVATE_TOKEN }} | |
| persist-credentials: false | |
| path: ./traffic_data | |
| - name: Create LFS file list (private repository) | |
| working-directory: ./traffic_data | |
| run: git lfs ls-files -l | cut -d' ' -f1 | sort > .lfs-assets-id | |
| shell: bash | |
| - name: Restore LFS cache (private repository) | |
| uses: actions/cache@v4 | |
| id: lfs-cache | |
| with: | |
| path: ./traffic_data/.git/lfs | |
| key: lfs-${{ hashFiles('./traffic_data/.lfs-assets-id') }}-v1 | |
| - name: Git LFS Pull (private repository) | |
| working-directory: ./traffic_data | |
| run: | | |
| git remote set-url origin https://xoolive:${{ secrets.PRIVATE_TOKEN }}@github.com/xoolive/traffic_data.git | |
| git lfs pull | |
| unzip ENV_PostOPS_AIRAC_2111_04NOV2021_With_Airspace_Closure.zip -d airac_2111 | |
| shell: bash | |
| - name: Cache folder for traffic | |
| uses: actions/cache@v4 | |
| id: cache-folder | |
| with: | |
| path: | | |
| ~/.cache/traffic/ | |
| key: traffic-${{ hashFiles('uv.lock') }} | |
| - name: Ubuntu system dependencies | |
| run: | | |
| sudo apt update | |
| sudo apt install -y libgdal-dev libgeos-dev libproj-dev proj-bin proj-data | |
| - name: Install project | |
| run: | | |
| uv sync --dev --all-extras | |
| - name: Run tests | |
| env: | |
| LD_LIBRARY_PATH: /usr/local/lib | |
| TRAFFIC_NM_PATH: /home/runner/work/traffic/traffic/traffic_data/airac_2111 | |
| run: | | |
| uv run traffic cache --fill # download files to have in cache first | |
| uv run pytest --cov --cov-report xml -m "" | |
| - name: Upload coverage to Codecov | |
| if: ${{ github.event_name != 'pull_request_target' }} | |
| uses: codecov/codecov-action@v5 | |
| with: | |
| token: ${{ secrets.CODECOV_TOKEN }} | |
| env_vars: PYTHON_VERSION |