ci: Set persist-credentials to false for all instances of actions/checkout.

[junhaoliao]

Description

1. Set "persist-credentials" to false for all GH actions/checkout. Rationale: Remove persist-credentials or change the default to false actions/checkout#485

Validation performed

1. Merged the branch into @junhaoliao 's fork's main branch and observed all workflow runs were successful:

• deploy-github-pages: https://github.com/junhaoliao/yscope-log-viewer/actions/runs/12634700648
• lint: https://github.com/junhaoliao/yscope-log-viewer/actions/runs/12634700642
• test: https://github.com/junhaoliao/yscope-log-viewer/actions/runs/12634700659

Summary by CodeRabbit

• Chores
  • Updated GitHub Actions workflows to enhance security by preventing credential persistence during repository checkout.
  • Modified deployment, linting, and testing workflows to limit GitHub credential exposure.

[coderabbitai]

Walkthrough

The pull request introduces a consistent configuration change across multiple GitHub Actions workflow files. Specifically, the actions/checkout@v4 step in .github/workflows/deploy-gh-pages.yaml, .github/workflows/lint.yaml, and .github/workflows/test.yaml now includes the persist-credentials: false option. This modification affects how GitHub credentials are handled during repository checkout, potentially enhancing security by preventing credential persistence across workflow steps.

Changes

File	Change Summary
.github/workflows/deploy-gh-pages.yaml	Added persist-credentials: false to actions/checkout@v4 step
.github/workflows/lint.yaml	Added persist-credentials: false to actions/checkout@v4 step
.github/workflows/test.yaml	Added persist-credentials: false to actions/checkout@v4 step

The changes are identical across all three workflow files, focusing on modifying the credential handling during repository checkout.

---

📜 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 8041816 and d0adb63.

📒 Files selected for processing (3)

• .github/workflows/deploy-gh-pages.yaml (1 hunks)
• .github/workflows/lint.yaml (1 hunks)
• .github/workflows/test.yaml (1 hunks)

🔇 Additional comments (3)

.github/workflows/test.yaml (1)

26-26: Security enhancement looks good, eh!

The addition of persist-credentials: false is a proper security measure that prevents the GitHub token from being persisted beyond the checkout step. This is particularly beneficial since subsequent steps don't require GitHub authentication.

.github/workflows/deploy-gh-pages.yaml (1)

21-21: Looks beauty for Pages deployment!

The persist-credentials: false setting works well here since the Pages deployment uses a separate authentication mechanism through the id-token permission. The deployment job's permissions are properly configured to handle this.

.github/workflows/lint.yaml (1)

30-30: Right proper security enhancement!

The persist-credentials: false setting is appropriately added while maintaining the necessary actions:write permission for job cancellation functionality. The linting process doesn't require GitHub authentication, so this change is safe.

Let's verify that no other workflow steps require GitHub token authentication:

✅ Verification successful

Security enhancement verified - no conflicts with other workflows

The persist-credentials: false setting in the lint workflow is safe. The only other workflow using GitHub authentication is the PR title checker, which operates independently with its own minimal permissions scope.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Search for potential GitHub API or authentication usage in workflows
rg -l "GITHUB_TOKEN|github.token" .github/workflows/

Length of output: 93

---

Script:

#!/bin/bash
# Examine the content of pr-title-checks workflow
cat .github/workflows/pr-title-checks.yaml

Length of output: 598

---

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

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

[kirkrodrigues]

For the PR title, how about:

ci: Set `persist-credentials` to `false` for all instances of `actions/checkout`.