Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update release workflow #591

Merged
merged 1 commit into from
Nov 11, 2024
Merged

Update release workflow #591

merged 1 commit into from
Nov 11, 2024

Conversation

edenhaus
Copy link
Contributor

@edenhaus edenhaus commented Nov 11, 2024

Summary by CodeRabbit

  • New Features

    • Streamlined workflow for releasing Python packages to PyPi, enhancing clarity and efficiency.
    • Added a step to dynamically set the package version based on the release tag.
  • Bug Fixes

    • Removed unnecessary steps in the publishing workflow, improving overall performance.
  • Documentation

    • Updated environment details in the workflow to include a direct link to the PyPi project management page.
  • Refactor

    • Simplified build system requirements in the project configuration.

Copy link
Contributor

coderabbitai bot commented Nov 11, 2024

Caution

Review failed

The pull request is closed.

Walkthrough

The pull request introduces modifications to the GitHub Actions workflow for publishing a Python package, renaming the job from deploy to release and enhancing its configuration. Key changes include a new URL for the PyPi project management page and explicit permissions for contents and id-token. The pyproject.toml file has also been updated to streamline the build system by removing unnecessary dependencies and explicitly setting the project version. These changes clarify the workflow's purpose and improve the versioning process without altering existing dependencies.

Changes

File Change Summary
.github/workflows/python-publish.yml - Job renamed from deploy to release
- Updated environment with URL for PyPi project management
- Added step for setting package version
- Modified publish step to use uv publish command
pyproject.toml - Updated requires field to only include "hatchling"
- Replaced dynamic field with explicit version set to "0.0.0"

Possibly related PRs

  • Use uv instead of pip #564: The changes in this PR involve the transition from using pip to uv for package management, which aligns with the modifications in the main PR that enhance the workflow for publishing a Python package using uv.
  • Use uv build #571: This PR includes updates to the python-publish.yml file that streamline the build process using uv, which is relevant to the main PR's focus on improving the workflow for releasing packages with uv.

Poem

🐇 In the garden where code does bloom,
A workflow's name sheds its old costume.
With uv we publish, clear and bright,
To PyPi we send our packages light.
Version set, dependencies few,
Hopping along, we build anew! 🌼


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • 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.

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 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.

@edenhaus edenhaus merged commit 70def41 into dev Nov 11, 2024
6 checks passed
@edenhaus edenhaus deleted the update-release-flow branch November 11, 2024 13:03
Copy link

codecov bot commented Nov 11, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 86.67%. Comparing base (066c48a) to head (e5b3f38).
Report is 20 commits behind head on dev.

Additional details and impacted files
@@           Coverage Diff           @@
##              dev     #591   +/-   ##
=======================================
  Coverage   86.67%   86.67%           
=======================================
  Files          89       89           
  Lines        3324     3324           
  Branches      533      533           
=======================================
  Hits         2881     2881           
  Misses        389      389           
  Partials       54       54           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@edenhaus edenhaus added the pr: refactor PR with code refactoring label Nov 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
pr: refactor PR with code refactoring
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant