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

[deploy] use Trusted Publisher instead of API token #17

Merged
merged 1 commit into from
Jan 22, 2025

Conversation

capcom6
Copy link
Member

@capcom6 capcom6 commented Jan 21, 2025

Summary by CodeRabbit

  • Chores
    • Updated GitHub Actions workflow for package publishing
    • Simplified workflow configuration
    • Enhanced security settings for package deployment

Copy link

coderabbitai bot commented Jan 21, 2025

Walkthrough

The pull request modifies the GitHub Actions workflow for publishing a Python package. The changes simplify the workflow configuration by removing detailed comments and updating the deployment process. The workflow now includes a specific PyPI environment and adjusts permissions for package publication, likely transitioning to a more modern authentication method for package uploads.

Changes

File Change Summary
.github/workflows/publish.yml - Reduced workflow comments
- Added environment section with pypi name
- Updated permissions to include id-token: write
- Removed with parameters for authentication

Poem

🐰 A Rabbit's Publish Rhyme 🚀

Workflows dance with GitHub's might,
Permissions set, deployment's bright
PyPI beckons, package takes flight
Simplicity wins the coding fight!

Hop hop hooray! 🎉


🪧 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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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.

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.

Actionable comments posted: 0

🧹 Nitpick comments (1)
.github/workflows/publish.yml (1)

Line range hint 42-42: Consider pinning to a specific version for better stability.

While using @release/v1 works, pinning to a specific version (e.g., @v1.8.1) would provide better stability and predictability for your deployment pipeline.

-      uses: pypa/gh-action-pypi-publish@release/v1
+      uses: pypa/gh-action-pypi-publish@v1.8.1
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between e31dcdc and ddc831e.

📒 Files selected for processing (1)
  • .github/workflows/publish.yml (2 hunks)
🔇 Additional comments (3)
.github/workflows/publish.yml (3)

15-17: LGTM! Environment configuration aligns with Trusted Publisher requirements.

The environment configuration is correctly set up for PyPI's Trusted Publisher feature, providing better security through OIDC.


18-19: LGTM! Correct permissions for PyPI Trusted Publisher.

The id-token: write permission is correctly configured for OIDC authentication with PyPI's Trusted Publisher feature.


Line range hint 1-42: Verify PyPI Trusted Publisher configuration.

While the workflow changes are correct, ensure that you have:

  1. Added GitHub as a trusted publisher in your PyPI account settings
  2. Configured the following publishing requirements in PyPI:
    • Repository owner: capcom6
    • Repository name: current repository name
    • Workflow name: Upload Python Package
    • Environment: pypi
🧰 Tools
🪛 actionlint (1.7.4)

22-22: the runner of "actions/checkout@v3" action is too old to run on GitHub Actions. update the action's version to fix this issue

(action)

@capcom6 capcom6 merged commit a707ff0 into master Jan 22, 2025
10 checks passed
@capcom6 capcom6 deleted the deploy/trusted-publisher-method branch January 22, 2025 01:39
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