ci(publish-to-npm): Add provenance flag to npm publish and update permissions.

[junhaoliao]

Description

This PR updates the release script in package.json to include the --provenance flag when publishing the package. Additionally, the GitHub Actions workflow publish-to-npm.yml has been updated to:

• Add the id-token: write permission specifically to the publish-to-npm job, enabling the minting of an ID token required for the --provenance flag.

These changes ensure secure and traceable package publishing.

Checklist

• The PR satisfies the contribution guidelines.
• This is a breaking change and that has been indicated in the PR title, OR this isn't a
  breaking change.
• Necessary docs have been updated, OR no docs need to be updated.

Validation performed

• Performed a dry run (--dry-run) of npm publish with the --provenance flag to ensure no issues arise: npm publish --dry-run --provenance.

Summary by CodeRabbit

• Chores
  • Enhanced the package release process by incorporating provenance information, subsequently increasing the security and verifiability of releases.
  • Updated internal publishing permissions to support these enhancements, ensuring a more robust and transparent publication workflow.

[coderabbitai]

Walkthrough

The update introduces support for provenance in the npm publishing process. In the GitHub Actions workflow, a new permissions setting is added with id-token set to "write", enabling the generation and use of an ID token for authentication during the publish job. Additionally, the "release" script in the package.json file has been updated to include the --provenance flag with the npm publish command. These changes streamline the authentication and provenance reporting process while leaving the overall workflow structure unchanged.

Changes

File	Change Summary
.github/.../publish-to-npm.yml	Added a permissions section with id-token: "write" to enable ID token generation for the npm publish process with the --provenance flag.
package.json	Modified the "release" script to append the --provenance flag to the npm publish command, ensuring provenance information is included during publish.

Sequence Diagram(s)

sequenceDiagram
    participant Runner as GitHub Actions Runner
    participant Job as publish-to-npm Job
    participant Registry as npm Registry

    Runner->>Job: Trigger publish-to-npm job
    Job->>Job: Set permissions (id-token: "write")
    Job->>Job: Run release script (npm publish --provenance)
    Job->>Registry: Publish package with provenance info
    Registry-->>Job: Return publish confirmation

Loading

---

📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 7dc03eb and 9d783ed.

📒 Files selected for processing (2)

• .github/workflows/publish-to-npm.yml (1 hunks)
• package.json (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (2)

• GitHub Check: lint (macos-latest)
• GitHub Check: lint (ubuntu-latest)

🔇 Additional comments (2)

package.json (1)

16-16: Enhanced Release Script with Provenance Flag

The inclusion of the --provenance flag in the npm publish command meets the PR objective of enhancing package security and traceability. Please ensure that any auxiliary scripts or CI configurations that interact with the release process are compatible with this change.

.github/workflows/publish-to-npm.yml (1)

37-40: Added ID-Token Write Permission for Publish Job

The new permissions block setting id-token to "write" under the publish-to-npm job correctly supports the functionality of the --provenance flag during publishing. This change properly aligns with the PR objectives and enhances the security and authentication process.

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai plan to trigger planning for file edits and PR creation.
• @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.