You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
Docs release step for the 2.3 line, gated on an installable
datajoint==2.3.xand a live database — so it happens at/around tag time, not in a normal content PR.What & why
mkdocs.yamlhasdatajoint_version: "2.2"(line ~253), but all 22 tutorial/how-to notebooks currently showDataJoint 2.2.2 connectedbanners, 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 read2.3.x) and the marker bumped — together.scripts/check_notebook_versions.pycompares each notebook's connection banner againstextra.datajoint_version, matching major.minor (any patch within the line passes)..github/workflows/check-notebooks.ymlruns this guard on every PR touching notebooks /mkdocs.yaml/ the script. No workflow executes notebooks — re-execution is manual.The recipe (one atomic PR)
datajoint==2.3.x(2.3.0 or 2.3.1 both satisfy a"2.3"marker).src/tutorials/**andsrc/how-to/**so their committed banners read2.3.x.mkdocs.yamldatajoint_version"2.2"→"2.3"(major.minor marker).2.3vs banners2.2.2, or banners2.3.xvs marker2.2).check-notebooks.yml(the guard) andmkdocs build --strictpass.Notes
2.3.xbanner satisfies a"2.3"marker, so this is not repeated for 2.3.2, 2.3.3, ….datajoint_version, so it stays small and green); this belongs here as its own release step.Already handled / related