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

Use GitHub as trusted publisher for PyPI publication #2343

Merged
merged 3 commits into from
Jan 24, 2024

Conversation

strickvl
Copy link
Contributor

@strickvl strickvl commented Jan 23, 2024

Poetry publication using a static username and password is no longer possible. This PR makes the necessary fixes for generating a one-time token to enable publication using Poetry. See https://github.com/marketplace/actions/pypi-token-mint for more.

At some point in the future we might want to do it fully in the way that PyPi recommend but for now this should get us back in business quickly.

Summary by CodeRabbit

  • New Features
    • Enhanced the package publishing workflow with improved security and automation.
    • Nightly builds now utilize Poetry for package management, ensuring consistency with the release process.

@strickvl strickvl added bug Something isn't working internal To filter out internal PRs and issues labels Jan 23, 2024
Copy link
Contributor

coderabbitai bot commented Jan 23, 2024

Important

Auto Review Skipped

Auto reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository.

To trigger a single review, invoke the @coderabbitai review command.

Walkthrough

The project's GitHub workflows have been updated to enhance the package publishing process. Both workflows now utilize Poetry for building the package, and a new step has been introduced to mint a token specifically for publishing. The nightly workflow additionally includes a check to ensure the version matches the branch tag before release.

Changes

File Path Change Summary
.github/workflows/publish_to_pypi.yml Added permissions for trusted publishing, switched to Poetry for package building, and added token minting for publishing.
.github/workflows/publish_to_pypi_nightly.yml Updated to build with Poetry, added custom action for token minting, and included a conditional version check before publishing.

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>.
    • Generate unit-tests for this file.
  • 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 from git 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.

@strickvl
Copy link
Contributor Author

@coderabbitai review

Copy link
Contributor

coderabbitai bot commented Jan 23, 2024

@strickvl, I'm ready to review the pull request. Please provide any specific instructions or areas of focus for the review, if any.

Action performed

Review triggered.

Copy link
Contributor

@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: 2

Configuration used: .coderabbit.yaml

Commits Files that changed from the base of the PR and between 734b205 and 736db78.
Files selected for processing (2)
  • .github/workflows/publish_to_pypi.yml (2 hunks)
  • .github/workflows/publish_to_pypi_nightly.yml (1 hunks)
Additional comments: 5
.github/workflows/publish_to_pypi.yml (3)
  • 9-12: Permissions have been added to allow for trusted publishing. Ensure that the id-token: write and contents: read permissions are the minimum required and are securely managed.
  • 33-34: The package building process has been modified to use Poetry. Confirm that the poetry build command is correctly configured and that all necessary dependencies are installed prior to this step.
  • 35-37: A new step to mint a token has been introduced. Verify that the tschm/[email protected] action is a trusted and secure action, and that it is being used correctly within the workflow.
.github/workflows/publish_to_pypi_nightly.yml (2)
  • 49-50: The build package step for the nightly workflow has been added. Confirm that the poetry build command is correctly configured for nightly builds and that the environment is correctly set up for this step.
  • 51-53: A token minting step has been introduced in the nightly workflow. Verify that the tschm/[email protected] action is a trusted and secure action, and that it is being used correctly within the workflow.

.github/workflows/publish_to_pypi.yml Show resolved Hide resolved
.github/workflows/publish_to_pypi_nightly.yml Outdated Show resolved Hide resolved
Copy link
Contributor

@safoinme safoinme left a comment

Choose a reason for hiding this comment

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

LGTM

@strickvl
Copy link
Contributor Author

/fulltest

@strickvl strickvl merged commit a4f5e8e into develop Jan 24, 2024
34 of 35 checks passed
@strickvl strickvl deleted the bugfix/use-github-as-trusted-publisher-for-pypi branch January 24, 2024 08:12
kabinja pushed a commit to kabinja/zenml that referenced this pull request Jan 29, 2024
* change publish workflow

* update nightly release

* delete unused script
adtygan pushed a commit to adtygan/zenml that referenced this pull request Mar 21, 2024
* change publish workflow

* update nightly release

* delete unused script
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working internal To filter out internal PRs and issues
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants