refactor: rename tag → key across orcapod-python#136
Conversation
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Hard break — no deprecation aliases, no migration shims. All public and private identifiers, docstrings, comments, module names, file names, and serialized column prefixes containing tag/Tag renamed to key/Key. Updates CHANGELOG.md with full name-mapping table. Fixes ENG-455 Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Codecov Report❌ Patch coverage is 📢 Thoughts on this report? Let us know! |
Post-rename cleanup: mechanical tag→key substitution left phrases like "each key key from the data's key" and "shared key keys". Rephrase all occurrences to use "key-schema columns" (for column-name contexts) or "each field from the data's Key" (for module-level docstrings). Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
|
Response to Copilot review: No code changes required. Copilot flagged that it was unable to review this PR due to the 20,000-line limit. This is expected — the PR is a mechanical, codebase-wide rename of The rename was verified by:
No code change was needed in response to this automated comment. |
Review round summaryReviewer: Copilot (automated) The only review comment was Copilot's automated notice that it could not review the PR because it exceeds its 20,000-line limit. This is expected for a codebase-wide rename of Since the context of this PR (last two commits) were already pushed:
All 3,190 tests pass on the branch tip. |
| on: | ||
| push: | ||
| tags: | ||
| keys: |
There was a problem hiding this comment.
This is wrong -- this is Git tag and thus should not be modified
There was a problem hiding this comment.
Fixed. Reverted back to on the trigger — this is a GitHub Actions Git tag filter and should never have been touched by the rename script. Also restored the two / comments in this file. Committed in ca7ba6a.
| steps: | ||
| - uses: actions/checkout@v4 | ||
| with: | ||
| fetch-depth: 0 # required: hatch-vcs needs full tag history |
There was a problem hiding this comment.
Again this is the wrong "tag" to rename -- this should remain tag as it's referring to Git tag
There was a problem hiding this comment.
Fixed. Restored the comment to read 'hatch-vcs needs full tag history' — this is referring to Git tags needed by hatch-vcs for version inference, not the orcapod key schema concept. The rename script should have excluded these workflow files. Committed in ca7ba6a.
The tag→key rename script incorrectly changed "tags:" (GitHub Actions push trigger) and "tag history" / "reads tag" (hatch-vcs comments) to "keys:" and "key history" in publish.yml and run-tests.yml. These refer to Git tags, not orcapod key schema columns, and must remain unchanged. Fixes: publish.yml on.push.tags, two hatch-vcs comments in publish.yml, two hatch-vcs comments in run-tests.yml. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Review round 2 summaryReviewer: @eywalker Changes madeThe
These all refer to Git tags (used by hatch-vcs for version inference and by the publish trigger), not the orcapod key-schema concept. The rename script's scope should have excluded |
|
After careful consideration, I have concluded that this name introduces more ambiguity and confusion than it solves, setting grounds for possible future bugs. Consequently, I'm dismissing the PR to maintain the |
Summary
Hard break rename of all `tag`/`Tag`/`TAG` identifiers to `key`/`Key`/`KEY`
throughout orcapod-python, landing before v0.1 stable.
Fixes ENG-455
Files renamed
Test plan