verify build provenance

[shogo82148]

Summary by CodeRabbit

• New Features

  • Introduced the ability to verify Perl binary using a GitHub token through a new input parameter.

• Enhancements

  • Improved consistency by updating the format of descriptions in action.yml.

• Configuration

  • Added @shogo82148/attestation-verify as a dependency.
  • Updated GitHub Actions workflow to include necessary permissions and environment variable assignments.

• Tests

  • Enhanced test cases to support the new GitHub token parameter.

[coderabbitai]

Walkthrough

The recent changes improve the GitHub Action for verifying Perl binaries. A new github-token input parameter has been introduced across relevant files to facilitate this verification process. Dependencies have been updated to include @shogo82148/attestation-verify. Descriptions within action.yml have been standardized to use double quotes. Additionally, the testing configuration and scripts have been updated to support the new functionality.

Changes

Files	Change Summary
action.yml	Added github-token input, updated descriptions and formatting to use double quotes for consistency.
package.json	Added @shogo82148/attestation-verify as a dependency.
src/installer.ts	Introduced githubToken parameter to getPerl and acquirePerl functions for verification.
src/setup-perl.ts	Updated run function to include the githubToken parameter and utilize it in the getPerl function call.
.github/workflows/test.yml	Added permissions for contents: read and incorporated GITHUB_TOKEN in npm test job.
__test__/installer.test.ts	Updated imports to ES6 syntax and introduced use of githubToken in test cases for acquiring Perl versions.

Poem

A token whispered in the night,
To verify with shining light,
Perl awakens with trusty guard,
Dependencies set, no task too hard.
Tests run true, in code we trust,
For every change, precision's a must.
🌙✨🐇

---

Tip

Early access features: disabled

We are currently testing the following features in early access:

• OpenAI gpt-4o model for code reviews and chat: OpenAI claims that this model is better at understanding and generating code than the previous models. We seek your feedback over the next few weeks before making it generally available.

Note:

• You can enable or disable early access features from the CodeRabbit UI or by updating the CodeRabbit configuration file.
• Please join our Discord Community to provide feedback and report issues.
• OSS projects are always opted into early access features.

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

[coderabbitai]

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 522a126 and be40911.

Files ignored due to path filters (7)

• dist/cache-save/index.js is excluded by !**/dist/**
• dist/cache-save/index.js.map is excluded by !**/dist/**, !**/*.map
• dist/cache-save/licenses.txt is excluded by !**/dist/**
• dist/setup/index.js is excluded by !**/dist/**
• dist/setup/index.js.map is excluded by !**/dist/**, !**/*.map
• dist/setup/licenses.txt is excluded by !**/dist/**
• package-lock.json is excluded by !**/package-lock.json

Files selected for processing (4)

• action.yml (2 hunks)
• package.json (1 hunks)
• src/installer.ts (5 hunks)
• src/setup-perl.ts (2 hunks)

Files skipped from review due to trivial changes (1)

• package.json

Additional comments not posted (6)

action.yml (2)

48-52: New Input Parameter Added: github-token.

The addition of the github-token input parameter is well-defined with an appropriate description and default value. This change aligns with the PR objectives to verify Perl binary provenance.

---

63-63: Standardization of Output Description Formatting.

Changing the description formatting from single to double quotes for cache-hit maintains consistency across the YAML file. This is a good practice for readability and maintainability.

src/installer.ts (3)

9-9: Import Added: verify from @shogo82148/attestation-verify.

The addition of the verify import is appropriate for the new functionality of verifying Perl binaries. This aligns with the PR's objective and is securely used within the acquirePerl function.

---

Line range hint 47-56: Function Signature Updated: getPerl.

The addition of the optional githubToken parameter to the getPerl function is correctly implemented. It enhances the function's capability to verify Perl binaries, which is a crucial security feature.

---

Line range hint 76-101: Function Signature and Logic Updated: acquirePerl.

The acquirePerl function now accepts an optional githubToken and uses it to verify the downloaded Perl binary. This is a significant enhancement for security. The implementation of the verify function within this context is correct and aligns with best practices for secure software distribution.

src/setup-perl.ts (1)

Line range hint 17-43: Updated run Function to Use githubToken.

The run function now correctly retrieves the githubToken from the action's inputs and passes it to the installer.getPerl function. This integration is essential for the verification of the Perl binary and enhances the security of the setup process.

[coderabbitai]

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between be40911 and d558883.

Files selected for processing (2)

• .github/workflows/test.yml (4 hunks)
• test/installer.test.ts (2 hunks)

Additional comments not posted (5)

__test__/installer.test.ts (3)

1-4: Updated import statements to ES6 syntax.

The update to ES6 import syntax enhances consistency and aligns with modern JavaScript best practices. This change should improve the maintainability of the code.

---

6-6: Addition of githubToken from environment variables.

This change is crucial for ensuring that the tests can utilize the GitHub token for verifying Perl binaries, aligning with the PR's objective of verifying build provenance.

---

34-34: Usage of githubToken in test case for acquiring Perl.

This change ensures that the test case reflects the new functionality of passing githubToken to the getPerl method. It's essential to verify that this token is correctly used within the method to authenticate or verify requests, as intended.

.github/workflows/test.yml (2)

18-20: Added contents: read permissions.

This change is necessary to allow the workflow to access repository contents, which might be required for operations that involve the GitHub token, such as fetching or verifying Perl binaries. This aligns with the security practices of least privilege.

---

48-49: Setup of GITHUB_TOKEN environment variable across various jobs.

Adding the GITHUB_TOKEN to the environment variables ensures that it is available for use in scripts and actions that require GitHub API access, such as fetching or verifying Perl binaries. This is a crucial part of the PR's goal to verify build provenance.

Also applies to: 129-130, 213-214