Skip to content
Open
3 changes: 2 additions & 1 deletion .github/AGENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,13 @@ CI/CD workflows and repo automation.
## Workflows (source of truth)
- `conda-package.yml` — Intel channel conda build/test pipeline
- `conda-package-cf.yml` — conda-forge-oriented build/test pipeline
- `intel-ci.yml` — Intel Python CI: builds and tests `conda-recipe-cf` for the platforms and Python versions the recipe declares (`ci/matrix.py`); see `ci/README.md`
- `build-with-clang.yml` — Intel clang compatibility checks
- `build-with-standard-clang.yml` — standard clang compatibility checks
- `build_pip.yml` — pip build pipeline with pre-release NumPy
- `pre-commit.yml` — lint/format checks
- `openssf-scorecard.yml` — security scanning

## Policy
- Treat workflow YAML as canonical for platform/Python matrices.
- Treat workflow YAML as canonical for platform/Python matrices, except `intel-ci.yml`, whose matrix is `conda-recipe-cf/conda_build_config.yaml`.
- Avoid doc claims about CI coverage unless present in workflow config.
112 changes: 112 additions & 0 deletions .github/workflows/intel-ci.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,112 @@
# Intel Python CI (gh-ci): builds and tests conda-recipe-cf for Intel's Jenkins, see ci/README.md
name: Intel Python CI

on:
push:
branches: [main]
tags: ['*']
pull_request:

permissions:
contents: read

concurrency:
group: intel-ci-${{ github.ref }}
cancel-in-progress: ${{ github.event_name == 'pull_request' }}

jobs:
matrix:
name: Platforms and Python versions
runs-on: ${{ vars.GH_CI_RUNNER || 'ubuntu-latest' }}
timeout-minutes: 10
outputs:
matrix: ${{ steps.declared.outputs.matrix }}
steps:
- uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
with:
persist-credentials: false

- uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0
with:
python-version: "3.14"

- name: Read the declared platforms and Python versions
id: declared
run: python ci/matrix.py --event "$GITHUB_EVENT_NAME" --github-output matrix

build:
name: ${{ matrix.name }} Python ${{ matrix.python }}
needs: matrix
runs-on: ${{ matrix.platform == 'windows' && (vars.GH_CI_WINDOWS_RUNNER || 'windows-2022') || (vars.GH_CI_RUNNER || 'ubuntu-latest') }}
timeout-minutes: 90
strategy:
fail-fast: false
matrix: ${{ fromJSON(needs.matrix.outputs.matrix) }}
defaults:
run:
shell: bash -el {0}
steps:
- uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
with:
persist-credentials: false
# The recipe takes its version from git describe.
fetch-depth: 0

# Miniforge 26.9.4-0 fails setup-miniconda's conda init on Windows runners; 26.7.2-0 works.
- uses: conda-incubator/setup-miniconda@be893c923ea9cf1cf7cd510fbdde27c7e18cbdcb # v4.1.0
with:
miniforge-version: 26.7.2-0
activate-environment: ""
conda-remove-defaults: "true"

- name: Install conda-build
run: conda install -y -q -n base --override-channels -c conda-forge conda-build

- name: Build and run the recipe tests
env:
PYTHON_VERSION: ${{ matrix.python }}
run: python ci/build.py --python "$PYTHON_VERSION" --output "$RUNNER_TEMP/output"

- uses: actions/upload-artifact@cf430e030ddbb5b0abf93d22962f4752f3646cd9 # v7.0.2
with:
name: mkl_umath ${{ matrix.name }} Python ${{ matrix.python }}
path: ${{ runner.temp }}/output/*.conda
if-no-files-found: error
# Jenkins downloads them within minutes of the run; tags keep them 30 days.
retention-days: ${{ startsWith(github.ref, 'refs/tags/') && 30 || 3 }}

test:
name: Test ${{ matrix.name }} Python ${{ matrix.python }}
needs: [matrix, build]
runs-on: ${{ matrix.platform == 'windows' && (vars.GH_CI_WINDOWS_RUNNER || 'windows-2022') || (vars.GH_CI_RUNNER || 'ubuntu-latest') }}
timeout-minutes: 45
strategy:
fail-fast: false
matrix: ${{ fromJSON(needs.matrix.outputs.matrix) }}
defaults:
run:
shell: bash -el {0}
steps:
- uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
with:
persist-credentials: false

- uses: actions/download-artifact@9000827ccba6bdab643e8b6fd33ac0654aef8333 # v8.0.2
with:
name: mkl_umath ${{ matrix.name }} Python ${{ matrix.python }}
path: ${{ runner.temp }}/artifacts

- uses: conda-incubator/setup-miniconda@be893c923ea9cf1cf7cd510fbdde27c7e18cbdcb # v4.1.0
with:
miniforge-version: 26.7.2-0
activate-environment: ""
conda-remove-defaults: "true"

- name: Install the package and run ci/test.py
env:
PYTHON_VERSION: ${{ matrix.python }}
EVENT: ${{ startsWith(github.ref, 'refs/tags/') && 'tag' || github.event_name == 'pull_request' && 'pr' || 'push' }}
COMMIT: ${{ github.event.pull_request.head.sha || github.sha }}
run: >-
python ci/hooks.py --python "$PYTHON_VERSION" --artifacts "$RUNNER_TEMP/artifacts"
--work "$RUNNER_TEMP/hooks" --event "$EVENT" --commit "$COMMIT"
1 change: 1 addition & 0 deletions AGENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@ CC=icx pip install --no-deps --no-build-isolation . # clang is also supported i
- **Workflows:** `.github/workflows/`
- `conda-package.yml` — main conda build/test pipeline
- `conda-package-cf.yml` — conda-forge-oriented build/test pipeline
- `intel-ci.yml` — Intel Python CI: builds and tests `conda-recipe-cf`; see `ci/README.md`
- `build_pip.yml` — validates pip build with pre-release NumPy
- `build-with-clang.yml` — Intel clang compatibility check
- `build-with-standard-clang.yml` — standard clang compatibility check
Expand Down
29 changes: 29 additions & 0 deletions ci/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# How Intel Python CI tests mkl_umath

Intel Python CI (gh-ci) builds and tests mkl_umath's conda-forge packages in GitHub Actions. Intel's Jenkins then tests each package again on Intel machines and scans it, and on a release tag publishes the packages it tested. Everything it needs from this repository is in this directory, one workflow, and the recipe it builds.

| File | Role |
|---|---|
| `../conda-recipe-cf/` | The recipe gh-ci builds. `conda_build_config.yaml` lists the Python versions. The recipe builds on Linux and Windows unless a platform-only skip in `meta.yaml`, such as `skip: true # [win]`, rules one out. |
| `../.github/workflows/intel-ci.yml` | One job reads the matrix, one job per platform and Python version builds and uploads `mkl_umath <Platform> Python <version>`, and one job per package tests it. |
| `matrix.py` | Reads the platforms and Python versions from the recipe. A pull request gets the oldest and the newest regular versions. |
| `build.py` | Builds one Python version with conda-build, which runs the recipe's own tests. |
| `hooks.py` | The workflow's test jobs: installs one package into a clean conda-forge environment with the requirements in `config.yml`, and runs `test.py` the way Jenkins does. |
| `config.yml` | Tells gh-ci which workflow builds the packages, what its artifacts are called, and what the tests and benchmarks need. |
| `test.py` | Runs the installed package's test suite with pytest, in Actions and again in Jenkins. |
| `benchmark.py` | Runs the asv suite in `../benchmarks/` against the installed package, in Jenkins only, on a bare-metal benchmarking machine. Jenkins requires it because `../benchmarks/` exists. |

The scripts need only the Python standard library and are the same in every repository gh-ci tests, except that `matrix.py` here looks for `conda-recipe-cf/` first. Scanning is not the repository's to define: Jenkins runs its own scans.

**A pull request into `main`.** Actions builds the oldest and the newest regular Python versions on Linux and Windows and tests each package. Jenkins notices the pull request within 3 minutes, waits for that whole run, and then tests and scans every package at once, and benchmarks the newest Linux one, sampling each benchmark once. Each cell posts its own status on the pull request, and `intel-ci/pr` sums them up.

**A release tag.** Actions builds every declared version, and Jenkins tests and scans all of them, and measures the benchmarks properly on the newest Linux one, before it publishes the release. A benchmark that fails fails the run; a slower one does not, as nothing compares the timings with a baseline yet.

To support another Python, add it to `conda-recipe-cf/conda_build_config.yaml`; nothing else lists versions. Try it locally from a conda base environment with conda-build:

```bash
python ci/matrix.py # every platform and Python version
python ci/matrix.py --event pull_request # what a pull request builds
python ci/build.py --python VERSION --output /tmp/out # VERSION: one matrix.py lists
python ci/hooks.py --python VERSION --artifacts /tmp/out --work /tmp/hooks
```
90 changes: 90 additions & 0 deletions ci/benchmark.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,90 @@
"""
Intel Python CI (gh-ci) benchmark of the installed package.

Intel's Jenkins runs this because the repository has a benchmarks/ directory:
once per pull request or tag, with the conda package of the newest regular
Linux Python installed in a clean conda-forge environment with the benchmark
requirements from ci/config.yml, on a bare-metal benchmarking machine, from an
empty working directory.

It runs the asv suite in benchmarks/ against the installed package, without a
build of its own, and records the results under the commit being tested, in
$GH_CI_RESULTS, which Jenkins keeps with the build. A pull request samples each
benchmark once, enough to show that every one still runs; a tag measures them
properly. A benchmark that fails fails the cell; a slower one does not, as
nothing compares the timings with a baseline yet.
"""

import json
import os
import pathlib
import subprocess
import sys

# asv's own dependency, which reads the comments in its configuration.
import json5

ASV_CONFIG = pathlib.Path("benchmarks", "asv.conf.json")


def asv_config(source: pathlib.Path, results: pathlib.Path) -> pathlib.Path:
"""Writes this run's asv configuration into the working directory.

It is the repository's own, with absolute paths, since asv reads them from
where the configuration is, and with results under GH_CI_RESULTS. It lists
one branch, HEAD: the checkout is the commit under test, detached, and asv
cannot resolve the repository's branches there.
"""
path = source / ASV_CONFIG
config = json5.loads(path.read_text(encoding="utf-8"))
work = pathlib.Path.cwd()
config.update(
repo=str((path.parent / config.get("repo", "..")).resolve()),
benchmark_dir=str(
(path.parent / config.get("benchmark_dir", "benchmarks")).resolve()
),
branches=["HEAD"],
results_dir=str(results / "asv"),
html_dir=str(work / "html"),
env_dir=str(work / "env"),
)
written = work / "asv.conf.json"
written.write_text(json.dumps(config, indent=2), encoding="utf-8")
return written


def main() -> int:
"""Runs the asv suite against the installed package."""
config = asv_config(
pathlib.Path(os.environ["GH_CI_SOURCE"]),
pathlib.Path(os.environ["GH_CI_RESULTS"]),
)
asv = [sys.executable, "-m", "asv"]
# asv keeps its machine description in ~/.asv-machine.json; this one stays
# with the run rather than with the machine's user.
home = pathlib.Path.cwd() / "home"
home.mkdir(exist_ok=True)
env = dict(os.environ, HOME=str(home))
described = subprocess.run(
asv + ["machine", "--yes", "--config", str(config)], env=env
)
if described.returncode:
return described.returncode
run = [
"run",
"--config",
str(config),
f"--environment=existing:{sys.executable}",
f"--set-commit-hash={os.environ['GH_CI_COMMIT']}",
"--no-pull",
"--show-stderr",
"--launch-method=spawn",
]
if os.environ.get("GH_CI_EVENT") != "tag":
run.append("--quick")
# asv exits 2 when a benchmark failed.
return subprocess.run(asv + run, env=env).returncode


if __name__ == "__main__":
sys.exit(main())
Loading
Loading