Skip to content

Developer docs with the release process; version set in one place - #2

Merged
hokb merged 4 commits into
mainfrom
single-version
Nov 5, 2026
Merged

hokb merged 4 commits into
mainfrom
single-version

Conversation

@hokb

@hokb hokb commented Nov 5, 2026 •

Copy link
Copy Markdown
Member

After this change, a new release takes one edited line plus a tag. Change project(numpy2x VERSION x.y.z ...) in CMakeLists.txt, merge, then push the tag vx.y.z.

  • docs/development.md now documents the whole developer workflow. New sections:

    • repository layout;
    • rules for changes: bit-identical to NumPy, two fixed workers, an async test for every new op, performance measured against main, Linux/Windows parity, the C ABI, formatting;
    • releases: the version, the tag, what the wheels workflow does, PyPI rules, re-running on a tag, new Python versions.

    The existing build, test, benchmark and Docker sections are unchanged.

  • tests/test_version.c compares nx_version() with numpy2x_VERSION from CMake (a compile definition). Before, it compared against a hard-coded literal, so every version bump had to edit this file as well.

  • wheels.yml gets a new first job, version. On tag runs it fails unless the tag is v followed by the version in CMakeLists.txt. The wheels and sdist jobs wait for it, so a wrong tag stops the run before anything is built or uploaded. The first 1.0.0 attempt had exactly this problem: wheels versioned 0.1.0 under the tag v1.0.0. On pull requests and manual runs that are not on a tag, the check is skipped.

Checked locally:

  • The version ctest passes (Linux, Release).
  • The tag check's sed extracts 1.0.0 from CMakeLists.txt and matches v1.0.0.
  • The workflow file parses as YAML.

This PR touches wheels.yml, so the wheels workflow runs on it too (without the tag check).

🤖 Generated with Claude Code

https://claude.ai/code/session_01JT2yHm85oFjgf1AcgGLUux

tests/test_version.c compares nx_version() with numpy2x_VERSION from
CMake instead of a literal. The wheels workflow gets a first job that
fails a tag run unless the tag is v<version of CMakeLists.txt>; wheels
and sdist wait for it.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01JT2yHm85oFjgf1AcgGLUux
@hokb hokb changed the title Set the version in one place; check release tags against it Developer docs with the release process; version set in one place Nov 5, 2026
@hokb

hokb commented Nov 5, 2026

Copy link
Copy Markdown
Member Author

leave out contributions for now (not decided yet, TODO)

hokb commented Nov 5, 2026

Copy link
Copy Markdown
Member Author

Done: docs/development.md no longer states terms for contributions; the "Licenses" section covers only the code license, the patent license and NOTICE.


Generated by Claude Code

@hokb
hokb merged commit 8b28535 into main Nov 5, 2026
11 checks passed
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.

2 participants