Skip to content

CI: Add GHA workflow for publishing package to PyPI#17

Merged
amotl merged 1 commit intomainfrom
pypi-publish
May 9, 2025
Merged

CI: Add GHA workflow for publishing package to PyPI#17
amotl merged 1 commit intomainfrom
pypi-publish

Conversation

@amotl
Copy link
Member

@amotl amotl commented May 9, 2025

What the title says.

@coderabbitai
Copy link

coderabbitai bot commented May 9, 2025 •
edited
Loading

Caution

Review failed

The pull request is closed.

Walkthrough

A new GitHub Actions workflow for building and publishing Python packages to PyPI was added. The workflow automates package validation on pull requests and nightly schedules, and publishes to PyPI on tagged releases. The changelog was updated to document the introduction of this workflow.

Changes

File(s) Change Summary
.github/workflows/release-pypi.yml Added a workflow to automate Python package build, validation, and publishing to PyPI.
CHANGES.md Updated changelog to note the addition of the PyPI publishing workflow.

Sequence Diagram(s)

sequenceDiagram
    participant Developer
    participant GitHub Actions
    participant PyPI

    Developer->>GitHub Actions: Push tag / PR / schedule / manual dispatch
    GitHub Actions->>GitHub Actions: Checkout code, setup Python, setup uv
    GitHub Actions->>GitHub Actions: Build package (sdist & wheel)
    alt On tag push (release)
        GitHub Actions->>PyPI: Publish package
    end
Loading

Poem

In the warren, code hops with glee,
Now GitHub builds, as easy as can be!
With every tag and nightly run,
Our package leaps to PyPI—what fun!
🐇✨
Changelog updated, the news is out—
The bunnies rejoice, and cheerfully shout!

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between b24eff6 and 68ae777.

📒 Files selected for processing (2)
  • .github/workflows/release-pypi.yml (1 hunks)
  • CHANGES.md (1 hunks)

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
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

‼️ IMPORTANT
Auto-reply has been disabled for this repository in the CodeRabbit settings. The CodeRabbit bot will not respond to your replies unless it is explicitly tagged.

  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@amotl amotl marked this pull request as ready for review May 9, 2025 23:16
@amotl amotl merged commit aaa32dc into main May 9, 2025
3 of 4 checks passed
@amotl amotl deleted the pypi-publish branch May 9, 2025 23:16
@coderabbitai coderabbitai bot mentioned this pull request May 10, 2025
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@amotl