Skip to content

chore: replace inline CGL steps with reusable GitHub Actions workflow#47

Merged
konradmichalik merged 1 commit intomainfrom
reusable-github-actions
Jul 28, 2025
Merged

chore: replace inline CGL steps with reusable GitHub Actions workflow#47
konradmichalik merged 1 commit intomainfrom
reusable-github-actions

Conversation

@konradmichalik
Copy link
Copy Markdown
Contributor

@konradmichalik konradmichalik commented Jul 25, 2025 •
edited by coderabbitai bot
Loading

Summary by CodeRabbit

  • Chores
    • Updated the automated workflow to use an external, reusable workflow for code linting and checks, streamlining maintenance and consistency.

@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Jul 25, 2025 •
edited
Loading

Walkthrough

The .github/workflows/cgl.yml GitHub Actions workflow was refactored to replace the detailed, inline job steps for the cgl job with a single call to an external reusable workflow. All previous explicit step definitions were removed in favor of referencing a centralized workflow.

Changes

File(s) Change Summary
.github/workflows/cgl.yml Replaced all inline job steps for the cgl job with a uses directive calling an external workflow.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~7 minutes

Poem

A single hop, the steps are gone,
The workflow now just moves along.
From lines and lines to just a call,
One rabbit leap replaced them all!
With code so neat and easy to see,
The garden's workflow runs with glee.
🐇✨

Note

⚡️ Unit Test Generation is now available in beta!

Learn more here, or try it out under "Finishing Touches" below.

✨ Finishing Touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch reusable-github-actions

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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai generate unit tests to generate unit tests 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.

coderabbitai[bot]
coderabbitai bot reviewed Jul 25, 2025
View reviewed changes
Copy link
Copy Markdown

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 70aba60 and a648f01.

📒 Files selected for processing (1)
  • .github/workflows/cgl.yml (1 hunks)
🔇 Additional comments (1)
.github/workflows/cgl.yml (1)

9-9: Double-check required secrets / inputs are forwarded

External reusable workflows don’t inherit repository secrets unless you explicitly pass them (e.g. secrets: inherit or individual mappings). Make sure the called workflow doesn't expect secrets you’re no longer providing; otherwise the job will fail at run-time.

.github/workflows/cgl.yml
# Migration
- name: Run Rector migration
run: composer migration:rector -- --dry-run
uses: jackd248/reusable-github-actions/.github/workflows/cgl.yml@main
Copy link
Copy Markdown

@coderabbitai coderabbitai bot Jul 25, 2025

Choose a reason for hiding this comment

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

🛠️ Refactor suggestion

Pin the reusable workflow to a commit SHA for supply-chain safety

Referencing main makes the build vulnerable to unintended changes in the external repository. Pin to a specific commit (or a signed tag) instead.

-    uses: jackd248/reusable-github-actions/.github/workflows/cgl.yml@main
+    uses: jackd248/reusable-github-actions/.github/workflows/cgl.yml@<commit-sha>

This still supports updates—just update the SHA when you intentionally pull in changes.

🤖 Prompt for AI Agents 
In .github/workflows/cgl.yml at line 9, the reusable workflow is referenced
using the branch name 'main', which can lead to supply-chain risks due to
unintended changes. Replace 'main' with a specific commit SHA or a signed tag
from the external repository to pin the workflow to a fixed version. This
ensures stability and security while still allowing controlled updates by
changing the SHA when desired.

@konradmichalik konradmichalik merged commit 6c30b0e into main Jul 28, 2025
27 of 30 checks passed
@konradmichalik konradmichalik deleted the reusable-github-actions branch July 28, 2025 17:13
@coderabbitai coderabbitai bot mentioned this pull request Dec 22, 2025
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@coderabbitai coderabbitai[bot] coderabbitai[bot] left review comments

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@konradmichalik