Skip to content

Add explicit UV CLI workflow for pyseekdb#154

Merged
hnwyllmm merged 2 commits into
oceanbase:developfrom
zhangjiongai-debug:develop
Jan 31, 2026
Merged

Add explicit UV CLI workflow for pyseekdb#154
hnwyllmm merged 2 commits into
oceanbase:developfrom
zhangjiongai-debug:develop

Conversation

@zhangjiongai-debug

@zhangjiongai-debug zhangjiongai-debug commented Jan 29, 2026 •
edited by coderabbitai Bot
Loading

Copy link
Copy Markdown
Contributor

Summary

  • Add Development section to README with UV workflow documentation (prerequisites, setup, common commands, build artifacts)
  • Update Testing section to use uv run pytest consistently
  • Add build job to CI workflow to verify uv build produces valid artifacts

Closes #130

Test plan

  • Verified uv build produces both .tar.gz and .whl artifacts locally
  • CI build job runs successfully

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Chores

    • Enhanced CI/CD pipeline with automated build verification and artifact management.

  • Documentation

    • Restructured and expanded development and setup instructions for improved clarity and ease of contributor onboarding.

✏️ Tip: You can customize this high-level summary in your review settings.

@zhangjiongai-debug @claude
Add explicit UV CLI workflow documentation and CI build check (oceanb…
6cb7415 
…ase#130)

- Add Development section to README with UV workflow documentation
  - Prerequisites: uv installation instructions
  - Setup Development Environment: clone and sync commands
  - Common Commands: uv run, uv build, uv add, etc.
  - Build Artifacts: output location description
- Update Testing section to use `uv run pytest` consistently
- Add `build` job to CI workflow to verify `uv build` works
- Upload build artifacts for inspection

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
@CLAassistant

CLAassistant commented Jan 29, 2026 •
edited
Loading

Copy link
Copy Markdown

CLA assistant check
All committers have signed the CLA.

@zhangjiongai-debug @claude
Unify workflow to use make commands
5c94647 
- Update CI build job to use `make build` instead of `uv build`
- Simplify README Development section to use make targets
- Document all available make targets (install, check, test, build, etc.)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
@coderabbitai

coderabbitai Bot commented Jan 29, 2026 •
edited
Loading

Copy link
Copy Markdown
📝 Walkthrough

Walkthrough

The changes add CI verification for UV-based package building and document the UV CLI workflow. A new GitHub Actions job executes uv build with artifact verification, while README.md restructures documentation to detail development setup using the uv package manager.

Changes

Cohort / File(s) Summary
CI Build Pipeline
.github/workflows/ci.yml		 Introduces a new build job to the CI pipeline that checks out code, sets up Python 3.11, executes uv build, verifies both sdist and wheel artifacts exist in dist/, and uploads build artifacts.
Documentation Restructuring
README.md		 Reorganizes documentation by introducing a new "Development" section detailing uv package manager setup, prerequisites, Makefile-based tasks, and build artifact verification; moves the "Testing" section to follow and updates example commands to reflect uv-based workflows.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

🐰 Hops through workflows, shiny and new,
UV builds packages, both sdist and wheel too!
The README dances with fresh documentation grace,
Development guides now have their proper place. 🏗️

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately reflects the primary change: adding UV CLI workflow documentation and CI integration.
Linked Issues check ✅ Passed The PR fulfills all requirements from #130: documents UV CLI workflow in README (Development section), ensures uv build works (CI job added), and clarifies tool support.
Out of Scope Changes check ✅ Passed All changes directly support the PR objectives. README restructuring documents the UV workflow, CI job verifies build artifacts, and Testing section updates use uv consistently.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@zhangjiongai-debug

zhangjiongai-debug commented Jan 29, 2026

Copy link
Copy Markdown
Contributor Author

Thanks for the review! I have updated the Makefile to integrate uv commands, and updated the CI workflow and README to use make test and make build consistently.

@zhanghuidinah zhanghuidinah mentioned this pull request Jan 30, 2026
Closed
3 tasks
hnwyllmm
hnwyllmm approved these changes Jan 31, 2026
View reviewed changes
Comment thread README.md
python3 -m pytest tests/integration_tests/ -v -k "oceanbase" # oceanbase mode (requires OceanBase)
# Run specific tests with uv run
uv run pytest tests/integration_tests/ -v -k "server" # server mode (requires seekdb server)
uv run pytest tests/integration_tests/ -v -k "oceanbase" # oceanbase mode (requires OceanBase)

@hnwyllmm hnwyllmm Jan 31, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

uv run pytest tests/integration_tests/ -v -k "embedded"

Comment thread README.md
make test-integration-embedded # Run embedded integration tests
make build # Build the package
make docs # Build documentation
make clean # Clean build artifacts

@hnwyllmm hnwyllmm Jan 31, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

make pre-commit

@hnwyllmm hnwyllmm merged commit 175c55f into oceanbase:develop Jan 31, 2026
8 checks passed
@coderabbitai coderabbitai Bot mentioned this pull request Feb 3, 2026
Merged
@hnwyllmm hnwyllmm mentioned this pull request Mar 12, 2026
Closed
3 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@hnwyllmm hnwyllmm hnwyllmm approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

[Enhancement]: Add explicit UV CLI workflow for pyseekdb

3 participants

@zhangjiongai-debug @CLAassistant @hnwyllmm