Skip to content

Prepare 0.1.0 release - #4

Merged
enumura1 merged 1 commit into
mainfrom
release/0.1.0
May 24, 2026
Merged

enumura1 merged 1 commit into
mainfrom
release/0.1.0

Conversation

@enumura1

@enumura1 enumura1 commented May 24, 2026 •

Copy link
Copy Markdown
Owner

Summary

  • add CHANGELOG.md for the initial 0.1.0 MVP release
  • update README and website installation docs for PyPI installation after release
  • document GitHub Releases as the place for wheel/source artifacts
  • add PyPI metadata classifiers and project URLs
  • clarify that the 0.1.x line is for early use and feedback

Validation

  • scripts/check
  • clean venv wheel install from dist/py_sql_cleaner-0.1.0-py3-none-any.whl
  • installed CLI smoke checks: py-sql-cleaner --help, py-sql-cleaner dialects, package import

Summary by CodeRabbit

  • Documentation

    • Released v0.1.0 as an early MVP with detailed capability documentation
    • Updated installation guide: package now available on PyPI
    • Clarified project status and compatibility expectations for early-stage users
  • Chores

    • Added project metadata including package classifiers and resource links

Review Change Stack

@coderabbitai

coderabbitai Bot commented May 24, 2026 •

Copy link
Copy Markdown

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro Plus

Run ID: 52081f06-30cd-47c3-9f9e-ccf1470200a5

📥 Commits

Reviewing files that changed from the base of the PR and between fa2c4ec and 04e51c8.

📒 Files selected for processing (6)
  • CHANGELOG.md
  • README.md
  • docs/development/branching.md
  • pyproject.toml
  • website/docs/getting-started/installation.md
  • website/docs/project/status.md

📝 Walkthrough

Walkthrough

This PR updates documentation and package metadata to support the 0.1.0 release of py-sql-cleaner. A changelog is introduced, installation guides are updated to reflect PyPI availability, package metadata is enhanced with classifiers and project URLs, and release procedures and project status are clarified.

Changes

0.1.0 Release Documentation and Metadata

Layer / File(s) Summary
Release announcement and project metadata
CHANGELOG.md, pyproject.toml
New changelog entry for 0.1.0 documents the initial MVP with implemented features and CLI commands; package metadata adds classifiers and project URLs (Documentation, Repository, Issues).
User installation documentation
README.md, website/docs/getting-started/installation.md
Installation guides updated to show explicit PyPI installation (pip install py-sql-cleaner), pipx alternative, and GitHub Releases downloads, removing prior "not yet published" messaging.
Release procedures and project status
docs/development/branching.md, website/docs/project/status.md
Release procedure clarified into three steps (build, publish to PyPI, create GitHub Release); project status explains 0.1.x is early MVP without long-term compatibility guarantees.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~4 minutes

Poem

🐰 The package is released, hooray hooray!
Docs bloom in PyPI's bright light,
🚀 Installation's smooth, the guides now say,
The changelog marks our MVP flight.

🚥 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 'Prepare 0.1.0 release' directly and clearly summarizes the main change: preparing all necessary documentation and metadata for the 0.1.0 release.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

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

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch release/0.1.0

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

@enumura1
enumura1 merged commit ecba96b into main May 24, 2026
2 checks passed
@coderabbitai coderabbitai Bot mentioned this pull request May 24, 2026
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.

1 participant