Skip to content

Follow the GitHub Actions best practices#290

Merged
5ouma merged 3 commits intomainfrom
ci-action-best-practice
Apr 22, 2025
Merged

Follow the GitHub Actions best practices#290
5ouma merged 3 commits intomainfrom
ci-action-best-practice

Conversation

@5ouma
Copy link
Owner

@5ouma 5ouma commented Apr 22, 2025

⚠️ Issue

close #


✏️ Description

Keep the GitHub Actions clean and secure.


5ouma added 2 commits April 22, 2025 14:22
Keep the GitHub Actions clean and secure.
Prevent unintended updates.
Copilot AI review requested due to automatic review settings April 22, 2025 05:34
@coderabbitai
Copy link

coderabbitai bot commented Apr 22, 2025

## Walkthrough

The updates modify several GitHub configuration and workflow files. The Renovate configuration now pins extended presets to a specific version. All GitHub Actions workflows introduce explicit timeout limits for jobs, varying between 1 and 3 minutes. Workflow steps using `actions/checkout` now include `persist-credentials` settings explicitly set to either `true` or `false` as appropriate. The pre-commit workflow pins the pre-commit action to a specific commit hash. The release workflow further specifies token permissions for content and pull requests.

## Changes

| Files                                      | Change Summary                                                                                                  |
|--------------------------------------------|----------------------------------------------------------------------------------------------------------------|
| .github/renovate.json                      | Updated to pin extended Renovate presets to version `v0.1.1` instead of using the latest version.              |
| .github/workflows/labeler.yml              | Added a 1-minute timeout limit to the "label" job.                                                             |
| .github/workflows/pre-commit.yml           | Set a 3-minute timeout for the pre-commit job and pinned the pre-commit action to a specific commit hash.       |
| .github/workflows/release.yml               | Added 1-minute timeouts to jobs, set `persist-credentials: true` or `false` explicitly in checkout steps, and specified token permissions. |
| .github/workflows/test.yml                  | Set a 3-minute timeout for the test job and added `persist-credentials: false` to the checkout step.            |

📜 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 5842217 and 0a9ac35.

📒 Files selected for processing (1)
  • .github/workflows/release.yml (3 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • .github/workflows/release.yml

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

@github-actions github-actions bot added the 🎽 CI Changes to CI configuration files and scripts label Apr 22, 2025
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR aims to improve the security and efficiency of the GitHub Actions workflows by enforcing best practices. Key changes include:

  • Setting stricter job timeouts to avoid runaway workflows.
  • Disabling credential persistence in checkout steps.
  • Updating workflow steps in release and pre-commit jobs to newer, secure versions.

Reviewed Changes

Copilot reviewed 4 out of 5 changed files in this pull request and generated no comments.

File Description
.github/workflows/test.yml Added a timeout and disabled credential persistence for the checkout step.
.github/workflows/release.yml Added timeouts, disabled persistent credentials, and introduced new permission inputs.
.github/workflows/pre-commit.yml Added a timeout and updated the pre-commit action version.
.github/workflows/labeler.yml Added a job timeout.
Files not reviewed (1)
  • .github/renovate.json: Language not supported
Comments suppressed due to low confidence (2)

.github/workflows/release.yml:65

  • The key 'permission-contents' appears non-standard; please verify whether this input is supported by the action or if it should be moved to a job-level permissions mapping.
          permission-contents: write

.github/workflows/release.yml:66

  • The key 'permission-pull-requests' is unusual; confirm that this is a valid input for the action or if it needs to be configured in another way as part of job-level permissions.
          permission-pull-requests: write

@codecov
Copy link

codecov bot commented Apr 22, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 18.05%. Comparing base (2983da7) to head (0a9ac35).
Report is 2 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #290   +/-   ##
=======================================
  Coverage   18.05%   18.05%           
=======================================
  Files           9        9           
  Lines         216      216           
=======================================
  Hits           39       39           
  Misses        163      163           
  Partials       14       14           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

coderabbitai[bot]
coderabbitai bot previously approved these changes Apr 22, 2025
@5ouma 5ouma merged commit 06fda28 into main Apr 22, 2025
9 checks passed
@5ouma 5ouma deleted the ci-action-best-practice branch April 22, 2025 06:03
@github-actions github-actions bot mentioned this pull request Apr 22, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

🎽 CI Changes to CI configuration files and scripts

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants