Skip to content

Move release action to OIDC with attestation #118

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
Merged
merged 1 commit into from
Jun 10, 2024
Merged

Move release action to OIDC with attestation #118

merged 1 commit into from
Jun 10, 2024

Conversation

ludeeus
Copy link
Owner

@ludeeus ludeeus commented Jun 10, 2024

No description provided.

@coderabbitai coderabbitai
Copy link

coderabbitai bot commented Jun 10, 2024 •
edited
Loading

Walkthrough

Walkthrough

The .github/workflows/release.yml file has been restructured to enhance the release process by splitting it into two distinct jobs: build and publish. The build job now focuses on packaging and uploading artifacts, while the publish job manages artifact download, publication to PyPI, build provenance attestation, and uploading release assets.

Changes

File Change Summary
.github/workflows/release.yml Restructured workflow into build and publish jobs, added steps for packaging, artifact handling, publishing to PyPI, and attesting build provenance.

Sequence Diagram(s)

sequenceDiagram
    actor Developer
    participant GitHubActions as GitHub Actions
    participant PyPI as PyPI
    participant Provenance as Build Provenance

    Developer->>GitHubActions: Push code to repository
    GitHubActions->>GitHubActions: Trigger `build` job
    GitHubActions->>GitHubActions: Package artifacts
    GitHubActions->>GitHubActions: Upload artifacts
    GitHubActions->>GitHubActions: Trigger `publish` job
    GitHubActions->>GitHubActions: Download artifacts
    GitHubActions->>PyPI: Publish artifacts
    GitHubActions->>Provenance: Attest build provenance
    GitHubActions->>GitHubActions: Upload release assets
Loading
Recent review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE

Commits

Files that changed from the base of the PR and between 1d5236e and 0bc4459.

Files selected for processing (1)
  • .github/workflows/release.yml (1 hunks)
Additional comments not posted (12)
.github/workflows/release.yml (12)

11-37: The restructuring of the build job looks well-organized and aligns with best practices for CI/CD pipelines.

14-14: Using a specific version of actions/checkout ensures stability and reproducibility.

16-16: Setting up Python with a specific version is a good practice to ensure consistent environments across builds.

20-20: Using pipx for installing poetry ensures that the package manager is isolated from other Python environments, which is a good practice.

24-24: Dynamically setting the version number using the release tag is a clever use of GitHub Actions variables to keep the package version synchronized with the release.

28-28: The use of poetry build for packaging is straightforward and effective.

30-36: Configuring artifact upload with error handling and a defined retention policy is a good practice to manage CI artifacts efficiently.

38-66: The publish job is well-structured, focusing on artifact handling, publishing, and security through build attestation.

50-50: Using a specific version of actions/download-artifact ensures that the step is stable and reproducible.

59-59: Using actions/attest-build-provenance enhances the security by providing a verifiable record of the build's integrity.

64-64: Using a specific version of action-gh-release ensures that the release asset upload process is stable and reproducible.

56-56: Using a specific commit of gh-action-pypi-publish ensures stability but verify that this commit version aligns with the latest stable features you need.

Verification successful

The specific commit 81e9d935c883d0b210363ab89cf05f3894778450 corresponds to the latest stable release v1.8.14 of gh-action-pypi-publish.

Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check for the latest stable release of gh-action-pypi-publish.

# Test: Fetch the latest stable release tag from GitHub.
gh repo view pypa/gh-action-pypi-publish --json releases --jq '.releases[0].tagName'

Length of output: 1186

Script:

#!/bin/bash
# Description: Check for the latest stable release of gh-action-pypi-publish.

# Test: Fetch the latest stable release tag from GitHub.
gh repo view pypa/gh-action-pypi-publish --json latestRelease --jq '.latestRelease.tagName'

Length of output: 99

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:

‼️ 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 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 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 as 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.

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

@ludeeus ludeeus added the internal For things that are considered internal to the project, things like documentation and CI changes label Jun 10, 2024
@ludeeus ludeeus merged commit e07c415 into main Jun 10, 2024
@ludeeus ludeeus deleted the releaseupdate branch June 10, 2024 11:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@coderabbitai coderabbitai[bot] coderabbitai[bot] approved these changes

Assignees
No one assigned
Labels
internal For things that are considered internal to the project, things like documentation and CI changes
Projects
None yet
Milestone
No milestone
Development

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