Skip to content

docs: add continuous-integration guide for the GitHub Actions suite - #1022

Merged
csmangum merged 20 commits into
devfrom
cursor/ci-workflows-doc-940f
Nov 1, 2026
Merged

csmangum merged 20 commits into
devfrom
cursor/ci-workflows-doc-940f

Conversation

@csmangum

@csmangum csmangum commented Oct 31, 2026 •

Copy link
Copy Markdown
Contributor

Description

Adds docs/guides/continuous-integration.md, a dedicated reference for the GitHub Actions suite. There was no such page; CI was mentioned only in one-liners in development-setup.md, deployment.md, and the RELEASE.md checklist.

The page covers:

  • What CI is responsible for, derived from the library's purpose (determinism, reproducibility, RL/evolution regression, installable package, API).
  • Inventory of all 10 workflows with triggers and purpose, plus per-job breakdowns for tests, Deterministic Simulation Check, nightly-heavy-tests, and Reproduce consensus experiment.
  • Merge gating as enforced by the "Protect main and dev" ruleset (python and js-ui are the only required checks).
  • Marker, coverage-gate, and environment-pinning policy.
  • Assessed gaps with recommendations, ordered by impact: non-blocking lint that is currently failing, narrow required checks, single Python/OS and unpinned deps, no packaging validation (wheel declares no dependencies), evolution regression not running on dev PRs, no type checking, no dependency/security scanning, workflow mechanics (concurrency, timeout-minutes, nightly notifications, coverage artifacts, docs build on PRs), and surfaces with no coverage (benchmarks, API startup, editor, scripts).
  • A suggested implementation order.

Links the new page from the docs hub (docs/README.md), CONTRIBUTING.md PR process, docs/RELEASE.md, and the two guides that previously carried the one-line mentions.

Related Issues

None.

Checklist

  • This PR targets the dev branch (not main)
  • My branch is up to date with the latest dev
  • I ran the test suite (pytest) and it passes — docs-only change; ran python scripts/check_docs_links.py (OK, 319 files)
  • I linted my changes (ruff check .) — no Python changes
  • I added or updated tests for behavior changes — not applicable
  • I updated documentation as necessary
Open in Web Open in Cursor 

Note

Low Risk
Documentation-only changes with no runtime, CI workflow, or branch-protection edits.

Reviewed by Cursor Bugbot for commit c02bf8f. Configure here.

cursoragent and others added 12 commits October 31, 2026 23:51
…ating, and gaps

Documents every GitHub Actions workflow, which jobs are required status
checks under the 'Protect main and dev' ruleset, marker/coverage/pinning
policy, and the assessed gaps with recommended fixes. Links the new page
from the docs hub, CONTRIBUTING, RELEASE, and the dev-setup/deployment
guides that previously carried one-line CI mentions.

Co-authored-by: csmangum <csmangum@gmail.com>
The lint job ran with continue-on-error, so Ruff failures surfaced as a
red job inside a green workflow. The baseline is clean on dev with the
pinned ruff==0.15.18, so the job can fail the workflow without any
code changes.

Co-authored-by: csmangum <csmangum@gmail.com>
The workflow only triggered on main, but all contributor PRs target dev,
so the threshold checks never ran on the PR that could introduce a
regression. Adds dev to both triggers, covers farm/core/decision and
farm/config (transitive imports of the regression test), dependency
files, and a manual trigger.

Co-authored-by: csmangum <csmangum@gmail.com>
The wheel previously shipped with no runtime dependencies, no
requires-python, no YAML config files, and bundled tests/, scripts/ and
benchmarks/ as top-level packages. pyproject.toml is now the single
source of truth: [project.dependencies] mirrors the former
requirements.txt, a dev extra holds the test tooling, packages.find is
restricted to farm*, and farm.config package data is declared.
requirements.txt is reduced to '-e .[dev]'.

Moves scripts/analysis_config.py into farm/analysis/ because three
package modules imported it, so an installed wheel could not import
farm.api.server. Adds scripts/ci/package_smoke.py and a 'package' CI
job that builds sdist+wheel, runs twine check, installs the wheel into
a clean venv, and runs a 5-step simulation from outside the checkout.
Release workflow also runs twine check. Python floor documented as
3.10.

Co-authored-by: csmangum <csmangum@gmail.com>
… canary

Adds requirements-lock.txt, generated by 'make lock' (uv pip compile,
universal across platforms for Python >= 3.10, no --upgrade so pins only
move when pyproject.toml changes or 'make lock-upgrade' is run). All
Python CI jobs now install from the lock with 'pip install -e . --no-deps',
and the lint job runs 'make lock-check' so a stale lock fails CI.

New latest-deps workflow installs the unpinned [project.dependencies]
weekly and runs the fast suite, so upstream breakage is detected and
attributed separately from code changes.

Co-authored-by: csmangum <csmangum@gmail.com>
Replaces the single ubuntu/3.10 job with a matrix: ubuntu 3.10 and 3.12
are required legs that enforce the coverage gate; ubuntu 3.13, Windows
3.12 and macOS 3.12 are informational legs (continue-on-error) that run
the same suite without the gate. pip caching moves to setup-python so it
works on every OS.

A new 'python' job aggregates the required pytest legs plus lint,
docs-links and package, keeping the status-check name the branch ruleset
already requires while making those jobs effectively blocking.

Co-authored-by: csmangum <csmangum@gmail.com>
Co-authored-by: csmangum <csmangum@gmail.com>
Dependabot covers pip, the farm/editor npm toolchain and GitHub Actions
with weekly grouped minor/patch bumps. A new security workflow runs
pip-audit (blocking, 3.10 and 3.12) against requirements-lock.txt with
explicitly justified ignores for the protobuf advisories pinned by
tianshou 0.4.11 and the Pillow advisories that need Python 3.11+, plus an
informational npm audit. CodeQL analyzes Python and JavaScript on push,
PR and a weekly schedule.

To get the lock off Pillow 11.3 (73 open advisories): moviepy moves to a
new 'media' extra because moviepy 2.x caps Pillow below 12, and the
Pillow requirement forks so 3.10 gets 12.x and 3.11+ gets 13.

Co-authored-by: csmangum <csmangum@gmail.com>
Every PR-triggered workflow now cancels superseded runs for the same
ref, and every job has a timeout-minutes instead of the 6-hour default.
The nightly workflow no longer runs tests/test_deterministic_pytest.py a
second time (-m "" already selects it). A composite action opens or
comments on a 'ci-failure' tracking issue when nightly-heavy-tests,
latest-deps or the scheduled evolution-regression run fails.
reproduce-consensus.yml actions are SHA-pinned like the rest.

Co-authored-by: csmangum <csmangum@gmail.com>
… benchmark smokes

- typecheck job runs mypy (scoped via [tool.mypy] to farm/core, farm/api,
  farm/config); informational until the ~400-error baseline is cleared.
- Required pytest legs write coverage.xml and upload it as an artifact.
- scripts/ci/api_smoke.sh starts uvicorn as a real process and probes
  read-only endpoints; runs on the required pytest legs.
- pages.yml builds Jekyll on pull requests touching docs/ and deploys
  only on push/workflow_dispatch.
- Nightly benchmark-smoke job runs benchmarks/specs/ci_smoke.yaml
  (observation_flow, a few seconds) and uploads the results JSON.

Co-authored-by: csmangum <csmangum@gmail.com>
Reflects the matrix + gate job, packaging and API smokes, lock file,
security scanning, scheduled-failure issues, and the remaining gaps
(ruleset additions, mypy baseline, ruff format, benchmark trending).

Co-authored-by: csmangum <csmangum@gmail.com>
…2 CI leg

Axes.boxplot() removed the 'labels' keyword in matplotlib 3.11; use
tick_labels (available since 3.9) and raise the matplotlib floor to
match. The genetics CI-bounds test used a perfectly linear fitness, so
with scipy 1.18 the slope standard error is exactly zero and the strict
ordering assertion fails; add deterministic noise so the interval is
non-degenerate.

Co-authored-by: csmangum <csmangum@gmail.com>
ci: harden the GitHub Actions suite (priority items 1–8)
Co-authored-by: csmangum <30098247+csmangum@users.noreply.github.com>
Copilot AI and others added 2 commits November 1, 2026 02:08
Co-authored-by: csmangum <30098247+csmangum@users.noreply.github.com>
Co-authored-by: csmangum <30098247+csmangum@users.noreply.github.com>
Co-authored-by: csmangum <30098247+csmangum@users.noreply.github.com>
Co-authored-by: csmangum <30098247+csmangum@users.noreply.github.com>
Co-authored-by: csmangum <30098247+csmangum@users.noreply.github.com>
Co-authored-by: csmangum <30098247+csmangum@users.noreply.github.com>
@csmangum
csmangum merged commit cb4f12f into dev Nov 1, 2026
27 checks passed
@csmangum
csmangum deleted the cursor/ci-workflows-doc-940f branch November 1, 2026 03:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants