Skip to content

v2.3.1 docs release step: re-execute notebooks + bump datajoint_version to 2.3 #207

Description

@dimitri-yatsenko

Docs release step for the 2.3 line, gated on an installable datajoint==2.3.x and a live database — so it happens at/around tag time, not in a normal content PR.

What & why

mkdocs.yaml has datajoint_version: "2.2" (line ~253), but all 22 tutorial/how-to notebooks currently show DataJoint 2.2.2 connected banners, so it's consistent today and CI is green. To advance the covered version to 2.3, the notebooks must be re-executed under 2.3.x (so their banners read 2.3.x) and the marker bumped — together.

scripts/check_notebook_versions.py compares each notebook's connection banner against extra.datajoint_version, matching major.minor (any patch within the line passes). .github/workflows/check-notebooks.yml runs this guard on every PR touching notebooks / mkdocs.yaml / the script. No workflow executes notebooks — re-execution is manual.

The recipe (one atomic PR)

  • Install the released datajoint==2.3.x (2.3.0 or 2.3.1 both satisfy a "2.3" marker).
  • Stand up a live database — the banner is printed on connection, so notebooks must actually connect and execute (postgres/mysql).
  • Re-execute all 22 notebooks under src/tutorials/** and src/how-to/** so their committed banners read 2.3.x.
  • Bump mkdocs.yaml datajoint_version "2.2""2.3" (major.minor marker).
  • Land the notebook re-runs and the marker bump in one PR — either alone fails the guard (marker 2.3 vs banners 2.2.2, or banners 2.3.x vs marker 2.2).
  • Confirm check-notebooks.yml (the guard) and mkdocs build --strict pass.

Notes

  • Once per major.minor. Every 2.3.x banner satisfies a "2.3" marker, so this is not repeated for 2.3.2, 2.3.3, ….
  • Deliberately excluded from the content-cohesion PR docs: fold 2.3.1 changes into What's New in 2.3 + fix cross-link gaps #206 (that PR is text-only and doesn't touch datajoint_version, so it stays small and green); this belongs here as its own release step.
  • Overdue rather than blocked: 2.3.0 already qualifies, so it could be done as soon as the release env is ready.

Already handled / related

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions