chore: Fix dependencies of docs-serve Nox session
#8220
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: | |
| pull_request: | |
| types: [opened, reopened, labeled, synchronize] | |
| paths: | |
| - src/** | |
| - tests/** | |
| - docker-compose*.yml | |
| - noxfile.py | |
| - pyproject.toml | |
| - requirements/requirements*.txt | |
| - .github/workflows/tests.yml | |
| - .github/actions/install-tools/action.yml | |
| push: | |
| branches: | |
| - 'main' | |
| paths: | |
| - src/** | |
| - tests/** | |
| - docker-compose*.yml | |
| - noxfile.py | |
| - pyproject.toml | |
| - requirements/requirements*.txt | |
| - .github/workflows/tests.yml | |
| - .github/actions/install-tools/action.yml | |
| schedule: | |
| - cron: "25 7 * * 1" | |
| workflow_dispatch: | |
| inputs: | |
| all_integrations: | |
| description: "Test against all the latest LimeSurvey docker image tags and all database engines" | |
| required: true | |
| default: false | |
| type: boolean | |
| concurrency: | |
| group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }} | |
| cancel-in-progress: true | |
| env: | |
| FORCE_COLOR: "1" | |
| jobs: | |
| tests: | |
| name: "Test ${{ matrix.python-version }} ${{ matrix.nightly && '(nightly) ' || '' }}/ ${{ matrix.os }}" | |
| runs-on: ${{ matrix.os }} | |
| continue-on-error: ${{ matrix.experimental || false }} | |
| permissions: | |
| contents: read | |
| env: | |
| COVERAGE_FILE: ".coverage.unit" | |
| NOXFORCEPYTHON: "${{ matrix.python-version }}" | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| python-version: | |
| - "3.9" | |
| - "3.10" | |
| - "3.11" | |
| - "3.12" | |
| - "3.13" | |
| - "pypy3.10" | |
| os: ["ubuntu-latest"] | |
| include: | |
| - python-version: "3.8" | |
| os: "ubuntu-latest" | |
| - python-version: "3.14" | |
| os: "ubuntu-latest" | |
| experimental: true | |
| nightly: true | |
| - python-version: "3.13" | |
| os: "windows-latest" | |
| - python-version: "3.13" | |
| os: "macos-latest" | |
| steps: | |
| - name: Check out the repository | |
| uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 | |
| with: | |
| persist-credentials: false | |
| - name: Setup Python ${{ matrix.python-version }} | |
| if: "${{ !matrix.nightly }}" | |
| uses: actions/setup-python@0b93645e9fea7318ecaed2b359559ac225c90a2b # v5.3.0 | |
| with: | |
| python-version: ${{ matrix.python-version }} | |
| architecture: x64 | |
| allow-prereleases: true | |
| - name: Setup Python ${{ matrix.python-version }} (nightly) | |
| if: "${{ matrix.nightly }}" | |
| uses: deadsnakes/action@e640ac8743173a67cca4d7d77cd837e514bf98e8 # v3.2.0 | |
| with: | |
| python-version: "${{ matrix.python-version }}-dev" | |
| - name: Install tools | |
| uses: ./.github/actions/install-tools | |
| - name: Run Tests | |
| run: | | |
| nox --verbose -s tests -- --junit-xml=tests.xml | |
| - name: Upload coverage data | |
| uses: actions/upload-artifact@6f51ac03b9356f520e9adb1b1b7802705f340c2b # v4.5.0 | |
| with: | |
| include-hidden-files: true | |
| name: "coverage-unit-${{ matrix.os }}-${{ matrix.python-version }}-${{ matrix.nightly && 'nightly' || 'stable' }}" | |
| path: ".coverage.*" | |
| - name: Upload test results to Codecov | |
| if: ${{ !cancelled() }} | |
| uses: codecov/test-results-action@9739113ad922ea0a9abb4b2c0f8bf6a4aa8ef820 # v1.0.1 | |
| with: | |
| token: ${{ secrets.CODECOV_TOKEN }} | |
| file: tests.xml | |
| flags: unit-${{ matrix.os }}-${{ matrix.python-version }}-${{ matrix.nightly && 'nightly' || 'stable' }} | |
| - name: Run Doctests | |
| run: | | |
| nox -s xdoctest | |
| lint: | |
| name: Lint | |
| runs-on: ubuntu-latest | |
| permissions: | |
| contents: read | |
| steps: | |
| - name: Check out the repository | |
| uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 | |
| with: | |
| persist-credentials: false | |
| - uses: actions/setup-python@0b93645e9fea7318ecaed2b359559ac225c90a2b # v5.3.0 | |
| with: | |
| python-version: 3.x | |
| - name: Install tools | |
| uses: ./.github/actions/install-tools | |
| - name: Run Dependency Checks | |
| run: | | |
| nox -s deps | |
| - name: Run Mypy | |
| run: | | |
| nox -s mypy | |
| docker_tags: | |
| name: Get Docker tags | |
| runs-on: ubuntu-latest | |
| outputs: | |
| tags: ${{ steps.tags.outputs.tags }} | |
| permissions: | |
| contents: read | |
| steps: | |
| - name: Check out the repository | |
| uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 | |
| with: | |
| persist-credentials: false | |
| - name: Setup Python | |
| uses: actions/setup-python@0b93645e9fea7318ecaed2b359559ac225c90a2b # v5.3.0 | |
| with: | |
| python-version: 3.x | |
| architecture: x64 | |
| allow-prereleases: true | |
| - name: Install tools | |
| uses: ./.github/actions/install-tools | |
| - name: Test against required tags | |
| if: ${{ contains(github.event.pull_request.labels.*.name, 'Release') || inputs.all_integrations || github.event_name == 'schedule' }} | |
| run: | | |
| nox --verbose -s generate-tags > limesurvey-docker-tags.json | |
| - name: Test against latest tags | |
| if: ${{ !contains(github.event.pull_request.labels.*.name, 'Release') && !inputs.all_integrations && github.event_name != 'schedule' }} | |
| run: | | |
| echo '["6-apache", "5-apache"]' > limesurvey-docker-tags.json | |
| - name: Output tags | |
| id: tags | |
| run: | | |
| echo "tags=$(cat limesurvey-docker-tags.json)" >> $GITHUB_OUTPUT | |
| databases: | |
| name: Get database engines | |
| runs-on: ubuntu-latest | |
| outputs: | |
| engines: ${{ steps.engines.outputs.engines }} | |
| permissions: | |
| contents: read | |
| steps: | |
| - name: Check out the repository | |
| uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 | |
| with: | |
| persist-credentials: false | |
| - name: Test against all engines | |
| if: ${{ contains(github.event.pull_request.labels.*.name, 'Release') || inputs.all_integrations || github.event_name == 'schedule' }} | |
| run: | | |
| echo '["postgres", "mysql"]' > database-engines.json | |
| - name: Test against PostgreSQL | |
| if: ${{ !contains(github.event.pull_request.labels.*.name, 'Release') && !inputs.all_integrations && github.event_name != 'schedule' }} | |
| run: | | |
| echo '["postgres"]' > database-engines.json | |
| - name: Output engines | |
| id: engines | |
| run: | | |
| echo "engines=$(cat database-engines.json)" >> $GITHUB_OUTPUT | |
| integration: | |
| name: "integration ${{ matrix.python-version }} / ${{ matrix.image_tag || matrix.ref }} / ${{ matrix.database }}" | |
| runs-on: ubuntu-latest | |
| continue-on-error: true | |
| needs: [docker_tags, databases] | |
| permissions: | |
| contents: read | |
| env: | |
| COVERAGE_FILE: ".coverage.integration" | |
| LS_USER: citric_ci | |
| LS_PASSWORD: notverysecret | |
| LS_PORT: "8080" | |
| NOXSESSION: integration | |
| NOXFORCEPYTHON: "${{ matrix.python-version }}" | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| python-version: ["3.13"] | |
| database: ${{ fromJson(needs.databases.outputs.engines) }} | |
| ref: [""] | |
| context: [""] | |
| image_tag: ${{ fromJson(needs.docker_tags.outputs.tags) }} | |
| include: | |
| # Test on other Python versions | |
| - python-version: "3.8" | |
| image_tag: "6-apache" | |
| database: postgres | |
| - python-version: "3.9" | |
| image_tag: "6-apache" | |
| database: postgres | |
| - python-version: "3.10" | |
| image_tag: "6-apache" | |
| database: postgres | |
| - python-version: "3.11" | |
| image_tag: "6-apache" | |
| database: postgres | |
| - python-version: "3.12" | |
| image_tag: "6-apache" | |
| database: postgres | |
| - python-version: "3.14" | |
| image_tag: "6-apache" | |
| database: postgres | |
| - python-version: "pypy3.10" | |
| image_tag: "6-apache" | |
| database: postgres | |
| # Test Limesurvey/LimeSurvey branches | |
| - python-version: "3.13" | |
| ref: refs/heads/develop | |
| context: https://github.com/martialblog/docker-limesurvey.git#master:6.0/apache | |
| database: postgres | |
| - python-version: "3.13" | |
| ref: refs/heads/master | |
| context: https://github.com/martialblog/docker-limesurvey.git#master:6.0/apache | |
| database: postgres | |
| # - python-version: "3.12" | |
| # ref: refs/pull/3860/head | |
| # context: https://github.com/martialblog/docker-limesurvey.git#master:6.0/apache | |
| # database: postgres | |
| steps: | |
| - name: Check out the repository | |
| uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 | |
| with: | |
| persist-credentials: false | |
| - name: Setup Python ${{ matrix.python-version }} | |
| uses: actions/setup-python@0b93645e9fea7318ecaed2b359559ac225c90a2b # v5.3.0 | |
| with: | |
| python-version: ${{ matrix.python-version }} | |
| architecture: x64 | |
| allow-prereleases: true | |
| - name: Install tools | |
| uses: ./.github/actions/install-tools | |
| - name: Download LimeSurvey archive | |
| if: ${{ matrix.ref }} | |
| run: | | |
| wget https://github.com/LimeSurvey/LimeSurvey/archive/${{ matrix.ref }}.tar.gz -O ls.tar.gz -nv | |
| echo "LS_CHECKSUM=$(shasum -a 256 ls.tar.gz | cut -d' ' -f1)" >> $GITHUB_ENV | |
| - name: Set up Docker Buildx | |
| uses: docker/setup-buildx-action@6524bf65af31da8d45b59e8c27de4bd072b392f5 # v3.8.0 | |
| - name: Get Docker | |
| uses: actions-hub/docker/cli@f5fdbfc3f9d2a9265ead8962c1314108a7b7ec5d # v1.0.3 | |
| env: | |
| SKIP_LOGIN: true | |
| - name: Start services | |
| env: | |
| LS_IMAGE_TAG: ${{ matrix.image_tag }} | |
| LS_DOCKERFILE_CONTEXT: ${{ matrix.context }} | |
| LS_DOCKERFILE: Dockerfile | |
| LS_ARCHIVE_URL: "https://github.com/LimeSurvey/LimeSurvey/archive/${{ matrix.ref }}.tar.gz" | |
| COMPOSE_FILE: "\ | |
| docker-compose.yml\ | |
| ${{ matrix.ref && ':docker-compose.ref.yml' }}\ | |
| ${{ matrix.database == 'mysql' && ':docker-compose.mysql.yml' || '' }}" | |
| run: | | |
| docker compose up -d --wait --quiet-pull | |
| docker compose ps -a | |
| docker compose config | |
| - name: Run Nox | |
| id: nox-integration | |
| env: | |
| BACKEND: ${{ matrix.database }} | |
| LS_URL: http://localhost:${{ env.LS_PORT }} | |
| run: | | |
| nox -- --junit-xml=integration.xml | |
| - name: Upload test results to Codecov | |
| if: ${{ !cancelled() }} | |
| uses: codecov/test-results-action@9739113ad922ea0a9abb4b2c0f8bf6a4aa8ef820 # v1.0.1 | |
| with: | |
| token: ${{ secrets.CODECOV_TOKEN }} | |
| file: integration.xml | |
| flags: integration-${{ matrix.python-version }}-${{ matrix.image_tag || matrix.ref }}-${{ matrix.database }} | |
| - name: Upload coverage data | |
| if: always() | |
| uses: actions/upload-artifact@6f51ac03b9356f520e9adb1b1b7802705f340c2b # v4.5.0 | |
| with: | |
| include-hidden-files: true | |
| name: "coverage-integration-${{ matrix.python-version }}-${{ matrix.image_tag || env.LS_CHECKSUM }}-${{ matrix.database }}" | |
| path: ".coverage.*" | |
| coverage: | |
| name: Coverage | |
| runs-on: ubuntu-latest | |
| needs: [tests, integration] | |
| permissions: | |
| contents: read | |
| env: | |
| NOXSESSION: coverage | |
| strategy: | |
| matrix: | |
| flag: ["unit", "integration"] | |
| fail-fast: false | |
| steps: | |
| - name: Check out the repository | |
| uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 | |
| with: | |
| persist-credentials: false | |
| - name: Set up Python | |
| uses: actions/setup-python@0b93645e9fea7318ecaed2b359559ac225c90a2b # v5.3.0 | |
| with: | |
| python-version: "3.x" | |
| - name: Install tools | |
| uses: ./.github/actions/install-tools | |
| - name: Download coverage data | |
| uses: actions/download-artifact@fa0a91b85d4f404e444e00e005971372dc801d16 # v4.1.8 | |
| with: | |
| pattern: "coverage-${{ matrix.flag }}-*" | |
| merge-multiple: true | |
| - name: Combine coverage data and display human readable report | |
| continue-on-error: true | |
| run: | | |
| nox | |
| - name: Create coverage report | |
| run: | | |
| nox -- xml | |
| - name: Upload coverage report | |
| uses: codecov/codecov-action@1e68e06f1dbfde0e4cefc87efeba9e4643565303 # v5.1.2 | |
| with: | |
| token: ${{ secrets.CODECOV_TOKEN }} | |
| files: ./coverage.xml | |
| fail_ci_if_error: true | |
| flags: ${{ matrix.flag }} |