Skip to content

docs(development): Add polars version bump guide#1727

Open
eitsupi wants to merge 4 commits intomainfrom
docs/development-bump-guide
Open

docs(development): Add polars version bump guide#1727
eitsupi wants to merge 4 commits intomainfrom
docs/development-bump-guide

Conversation

@eitsupi
Copy link
Collaborator

@eitsupi eitsupi commented Feb 8, 2026

Summary

  • Add a new "Bumping the Polars Version" section to DEVELOPMENT.md documenting the step-by-step workflow for polars version bumps
  • Include real code examples for common deprecation patterns (parameter, method, class)
  • Document CI troubleshooting tips and NEWS.md conventions

Test plan

  • Verify the Markdown renders correctly on GitHub
  • Review code examples against the actual codebase for accuracy

🤖 Generated with Claude Code

Document the step-by-step workflow for bumping the polars version,
including common patterns for deprecations, CI troubleshooting tips,
and NEWS.md conventions. Based on lessons learned from the
py-1.37.1 → py-1.38.1 bump.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Copilot AI review requested due to automatic review settings February 8, 2026 08:56
@eitsupi eitsupi changed the title docs: Add polars version bump guide to DEVELOPMENT.md docs(DEVELOPMENT): Add polars version bump guide Feb 8, 2026
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds a new section to DEVELOPMENT.md documenting the workflow for bumping the pinned upstream Polars revision (in src/rust/Cargo.toml), with guidance on investigating upstream changes, regenerating artifacts, handling deprecations, and common CI issues.

Changes:

  • Documented a step-by-step process for updating the Polars git rev pins and rebuilding/regenerating artifacts.
  • Added examples for parameter/method/class deprecation patterns intended to mirror existing codebase practices.
  • Added CI troubleshooting notes and NEWS.md heading/link conventions for version bump PRs.

eitsupi and others added 2 commits February 8, 2026 09:04
This is a personal setup, not a standard part of the workflow.
Replace with generic guidance about comparing upstream tags.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
- Fix version bump explanation: DESCRIPTION is updated by build-lib-sums,
  not build-autogenerated-polars-version-file
- Fix build-all description to include build-lib-sums and build-readme
- Use local deprecated()/is_present() helpers instead of lifecycle:: prefix
- Fix sprintf argument order in deprecation example (format_arg before format_fn)
- Fix "deprecating a method" intro to cover both delegation and no-op patterns

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@eitsupi eitsupi changed the title docs(DEVELOPMENT): Add polars version bump guide docs(development): Add polars version bump guide Feb 8, 2026
@eitsupi eitsupi requested a review from Copilot February 8, 2026 09:12
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated 1 comment.

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