Use GitHub Actions to run pre-commit #130
Conversation
pre-commit.ci has a size limit.
WalkthroughThe pull request introduces several changes to the repository's configuration and documentation. It removes the Changes
Possibly related PRs
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (3)
💤 Files with no reviewable changes (1)
✅ Files skipped from review due to trivial changes (1)
🔇 Additional comments (1).github/workflows/pre-commit.yml (1)
The workflow uses a custom action
✅ Verification successfulLet me gather more information about the action's source code. Let me try a different approach to get the action's content. Action is safe but could use better versioning After reviewing the action's source code, I can confirm that it's a safe composite action that:
However, since there are no release tags in the repository, I recommend:
🏁 Scripts executedThe following scripts were executed for the analysis: Script: #!/bin/bash
# Description: Verify the custom action's source code and documentation
# Check if the action repository exists and is public
gh repo view 5ouma/utils
# Get the action's source code at the specified commit
gh api repos/5ouma/utils/contents/pre-commit?ref=23aec800e821891339568c454135bb9befe36fce
# Check for any security advisories
gh api graphql -f query='
{
repository(owner: "5ouma", name: "utils") {
vulnerabilityAlerts(first: 5) {
nodes {
securityVulnerability {
severity
advisory {
description
}
}
}
}
}
}'
Length of output: 2894 Script: #!/bin/bash
# Get the actual content of the action.yml file
gh api repos/5ouma/utils/contents/pre-commit/action.yml?ref=23aec800e821891339568c454135bb9befe36fce | jq -r '.content' | base64 -d
# Check if there are any releases/tags
gh api repos/5ouma/utils/tags
Length of output: 265 Script: #!/bin/bash
# Get the raw content of the action.yml file directly
curl -s https://raw.githubusercontent.com/5ouma/utils/23aec800e821891339568c454135bb9befe36fce/pre-commit/action.yml
# Check commit history for this specific file to understand its stability
gh api repos/5ouma/utils/commits?path=pre-commit/action.yml&per_page=5
Length of output: 4892 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? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this comment.
Copilot reviewed 3 out of 3 changed files in this pull request and generated no suggestions.
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Caution
Inline review comments failed to post. This is likely due to GitHub's limits when posting large numbers of comments.
Actionable comments posted: 2
🧹 Outside diff range and nitpick comments (2)
.github/workflows/pre-commit.yml (2)
3-6: Consider optimizing workflow triggersThe workflow currently runs on both push to main and pull requests, which could result in duplicate runs for the same commits when PRs are merged. Consider adding
paths-ignoreto exclude unnecessary runs or usingifconditions to prevent duplicate executions.on: push: branches: [main] + paths-ignore: + - '**.md' + - 'docs/**' pull_request: + paths-ignore: + - '**.md' + - 'docs/**'
1-14: Add workflow documentation and pre-commit configurationConsider adding:
- Workflow documentation explaining its purpose and configuration
- Pre-commit configuration details or link to configuration file
- Error handling and reporting configuration
name: 🚸 pre-commit +# This workflow runs pre-commit checks on all pull requests and pushes to main +# Configuration: .pre-commit-config.yaml + on: push: branches: [main] pull_request: jobs: pre-commit: runs-on: ubuntu-latest + timeout-minutes: 10 steps: - uses: actions/checkout@v4 + + - name: Cache pre-commit environments + uses: actions/cache@v3 + with: + path: ~/.cache/pre-commit + key: pre-commit-${{ hashFiles('.pre-commit-config.yaml') }} + - name: 🚸 Run pre-commit uses: 5ouma/utils/pre-commit@23aec800e821891339568c454135bb9befe36fce # main + continue-on-error: false
🛑 Comments failed to post (2)
.github/workflows/pre-commit.yml (2)
8-10:
⚠️ Potential issueFix runner specification and add workflow safeguards
- The runner specification
Ubuntu-Latestshould beubuntu-latest(case-sensitive)- Consider adding timeout and concurrency settings for better resource management
jobs: pre-commit: - runs-on: Ubuntu-Latest + runs-on: ubuntu-latest + timeout-minutes: 10 + concurrency: + group: ${{ github.workflow }}-${{ github.ref }} + cancel-in-progress: true📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.jobs: pre-commit: runs-on: ubuntu-latest timeout-minutes: 10 concurrency: group: ${{ github.workflow }}-${{ github.ref }} cancel-in-progress: true
12-14:
⚠️ Potential issueAdd missing checkout step
The workflow is missing the checkout step, which is required to access repository files for pre-commit checks.
steps: + - uses: actions/checkout@v4 - name: 🚸 Run pre-commit uses: 5ouma/utils/pre-commit@23aec800e821891339568c454135bb9befe36fce # main📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.steps: - uses: actions/checkout@v4 - name: 🚸 Run pre-commit uses: 5ouma/utils/pre-commit@23aec800e821891339568c454135bb9befe36fce # main
There was a problem hiding this comment.
Copilot reviewed 3 out of 3 changed files in this pull request and generated no suggestions.
close #
✏️ Description
pre-commit.ci has a size limit.
🔄 Type of the Change
Code of Conduct.