Overview of CI jobs#

Any jobs which run on pushes to pull requests are required to pass for the pull request to be merged.

For developers, the information in this table is pulled from information in the workflow files. That information should be kept up to date with the behaviour of the workflows, and new workflows must have this information added if they should be included in this table.

Name

Description

When it runs

File

Category

Test

Runs the unit test suite on Windows, the ultraslow tests on Linux, and tests for Qt bindings on Linux

On pushes to pull requests; on merges to main and maint/* branches

azure-pipelines.yml

Azure Pipelines

build_docs

Build the documentation (runs only changed examples for pull requests; runs all examples for the daily builds)

On pushes to pull requests; every day for main and maint/* branches [1]

.circleci/config.yml

CircleCI

linkcheck

Check for dead links in the documentation

First day of the month for main branch [1][2]

.circleci/config.yml

CircleCI

autofix.ci

Applies automatic fixes like linting, adding PR numbers to towncrier files, ensuring new Python files have headers, and keeping stated dependency versions consistent across multiple sources

On pushes to pull requests

.github/workflows/autofix.yml

GitHub Actions

Changelog

Check that the towncrier changelog files are present and formatted correctly

On pushes to pull requests

.github/workflows/check_changelog.yml

GitHub Actions

CircleCI scheduled

Opens issues as alerts for failed scheduled CircleCI workflows

Every day

.github/workflows/circleci_scheduled.yml

GitHub Actions

CodeQL

Identifies security vulnerabilities

On merges to main branch

.github/workflows/codeql-analysis.yml

GitHub Actions

Contributor credit

Opens pull requests to update information about who has contributed to the package, and how many people have cited the package in publications

First day of the month

.github/workflows/credit.yml

GitHub Actions

Scheduled updates

Opens pull requests to keep selected package dependencies and pre-commit hooks up to date

Every Monday

.github/workflows/scheduled_updates.yml

GitHub Actions

Sponsor review

Opens issues as reminders to check whether the current sponsors and supporting institutions listed on the website are up to date

1st February, June, and October

.github/workflows/sponsor_review.yml

GitHub Actions

Tests

Runs the unit test suite across a range of Linux and macOS platforms, Python versions, and dependency versions

On pushes to pull requests; on merges to main and maint/* branches

.github/workflows/tests.yml

GitHub Actions