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.

Sign up for GitHub

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

Jump to bottom

Add workflow: release to PyPI #17

Merged
merged 1 commit into from
Mar 24, 2024
Merged

Add workflow: release to PyPI #17

merged 1 commit into from
Mar 24, 2024

Conversation

ciscorn
Copy link
Member

@ciscorn ciscorn commented Mar 24, 2024 •
edited by coderabbitai bot
Loading

Summary by CodeRabbit

  • New Features
    • Automated the build and publish process of package distributions to PyPI using a GitHub Actions workflow named "Release."

@ciscorn ciscorn self-assigned this Mar 24, 2024
@coderabbitai coderabbitai
Copy link

coderabbitai bot commented Mar 24, 2024 •
edited
Loading

Walkthrough

A new GitHub Actions workflow named "Release" is introduced to automate the project's build using Rye on Ubuntu and publish package distributions to PyPI when triggered by releases.

Changes

File Change Summary
.github/workflows/release.yml Sets up the "Release" GitHub Actions workflow, triggering on releases, building with Rye, and publishing to PyPI.

🐇✨
In the code's garden, under the moon's soft glow,
A new workflow blooms, its purpose clear and bright.
From the release's spark, through Ubuntu's might,
To PyPI's fields, where our packages go.
🌟🚀📦

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>.
    • Generate unit-tests 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 tests 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit tests.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

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 as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • The JSON schema for the configuration file is available here.
  • 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

@codecov Codecov
Copy link

codecov bot commented Mar 24, 2024 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.61%. Comparing base (5488b42) to head (bdb8a8a).

Additional details and impacted files 
@@           Coverage Diff           @@
##             main      #17   +/-   ##
=======================================
  Coverage   98.61%   98.61%           
=======================================
  Files           2        2           
  Lines         506      506           
=======================================
  Hits          499      499           
  Misses          7        7
Flag Coverage Δ
unittests 98.61% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

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

coderabbitai[bot]
coderabbitai bot reviewed Mar 24, 2024
View reviewed changes
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 5488b42 and 8ad7c00.
Files selected for processing (1)
  • .github/workflows/release.yml (1 hunks)
Additional comments: 4
.github/workflows/release.yml (4)
  • 3-6: The workflow is currently triggered by pull requests, which might lead to unintended releases on every pull request merge. Consider using a tag-based trigger or manual dispatch for releases to ensure more control over when releases occur.
  • 17-18: Installing Rye using curl | bash poses a security risk if the URL is compromised. Consider downloading the script first, verifying its integrity with a checksum, and then executing it.
  • 20-21: The build step using Rye appears appropriate and straightforward for the project's needs.
  • 23-24: Ensure that PyPI API tokens are securely stored as GitHub Secrets and that the workflow permissions are correctly configured to access these secrets for publishing.

coderabbitai[bot]
coderabbitai bot reviewed Mar 24, 2024
View reviewed changes
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 5488b42 and abb1984.
Files selected for processing (1)
  • .github/workflows/release.yml (1 hunks)
Files skipped from review as they are similar to previous changes (1)
  • .github/workflows/release.yml

coderabbitai[bot]
coderabbitai bot reviewed Mar 24, 2024
View reviewed changes
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 5488b42 and 14f8164.
Files selected for processing (1)
  • .github/workflows/release.yml (1 hunks)
Files skipped from review as they are similar to previous changes (1)
  • .github/workflows/release.yml

coderabbitai[bot]
coderabbitai bot reviewed Mar 24, 2024
View reviewed changes
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 5488b42 and 257ce28.
Files selected for processing (1)
  • .github/workflows/release.yml (1 hunks)
Files skipped from review as they are similar to previous changes (1)
  • .github/workflows/release.yml

coderabbitai[bot]
coderabbitai bot reviewed Mar 24, 2024
View reviewed changes
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 5488b42 and bdb8a8a.
Files ignored due to path filters (1)
  • pyproject.toml is excluded by: !**/*.toml
Files selected for processing (1)
  • .github/workflows/release.yml (1 hunks)
Files skipped from review as they are similar to previous changes (1)
  • .github/workflows/release.yml

@ciscorn ciscorn merged commit 13e9759 into main Mar 24, 2024
7 checks passed
@ciscorn ciscorn deleted the ci-release-pypi branch March 24, 2024 16:44
ciscorn added a commit that referenced this pull request Mar 25, 2024
@ciscorn
Merge pull request #17 from MIERUNE/ci-release-pypi
b044a86 
Add workflow: release to PyPI
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@coderabbitai coderabbitai[bot] coderabbitai[bot] left review comments

Assignees

@ciscorn ciscorn

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@ciscorn