Update codeql.yml

[zubri]

Summary by CodeRabbit

• Chores
  • Enhanced CI/CD workflow flexibility by expanding branch triggers for push events to include feature and release branches.
  • Streamlined pull request triggers by removing specific branch references, focusing on the main branch and general security-related branches.

[coderabbitai]

Walkthrough

Walkthrough

The changes made to the .github/workflows/codeql.yml file involve updates to the branch specifications for triggering workflows during push and pull request events. The push event now includes branches matching the patterns "CU-*" and "SRU*", in addition to "main". For the pull_request event, the configuration has been simplified to include only "main" and the wildcard "SRU*", removing a specific branch reference. These modifications aim to enhance flexibility and streamline branch management for workflow triggers.

Changes

File	Change Summary
.github/workflows/codeql.yml	- Modified on.push.branches: from [ "main" ] to [ "main", "CU-*", "SRU*" ]
	- Modified on.pull_request.branches: from [ "CU-86b14j4e0_SRU2024_check-code-security-reports-at-GitHub-for-all-repos", "main", "CU-*", "SRU*" ] to [ "main", "SRU*" ]

---

Recent review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE

Commits

Files that changed from the base of the PR and between a83296c and 17793bd.

Files selected for processing (1)

• .github/workflows/codeql.yml (1 hunks)

Additional comments not posted (3)

.github/workflows/codeql.yml (3)

5-5: Verify the impact of adding CU-* branches to the push trigger.

Including CU-* branches in the push event will cause the CodeQL workflow to run on every push to any branch that matches this pattern. This could lead to increased workflow runs and resource consumption. Please confirm that this is the intended behavior.

To assess the potential impact, you can run the following script to list all branches matching CU-*:

#!/bin/bash
# Description: List all remote branches matching CU-* to estimate workflow runs.

# Expected result: A list of CU-* branches.
git ls-remote --heads origin "CU-*"

---

7-7: Possible omission of CU-* branches in pull_request triggers.

The pull_request trigger now includes only main and SRU* branches, excluding CU-*. If pull requests targeting CU-* branches require CodeQL analysis, consider adding CU-* back to ensure these PRs are analyzed.

Apply this diff to include CU-* branches in the pull_request event:

 pull_request:
     branches: [ "main", "SRU*" ]
+    branches: [ "main", "CU-*", "SRU*" ]

To check if there are open pull requests targeting CU-* branches, you can run:

#!/bin/bash
# Description: List open pull requests targeting CU-* branches.

# Expected result: A list of open PRs targeting CU-* branches.
gh pr list --state open --json number,title,baseRefName | jq '.[] | select(.baseRefName | test("^CU-"))'

---

7-7: Confirm removal of the specific branch from pull_request triggers.

The specific branch "CU-86b14j4e0_SRU2024_check-code-security-reports-at-GitHub-for-all-repos" has been removed from the pull_request triggers. Ensure that this branch is no longer active or required in the workflow.

To verify if this branch still exists, run:

#!/bin/bash
# Description: Check if the specific branch exists in the remote repository.

# Expected result: No output if the branch does not exist.
git ls-remote --heads origin "CU-86b14j4e0_SRU2024_check-code-security-reports-at-GitHub-for-all-repos"

Warning

Review ran into problems

Problems

Git: Failed to clone repository. Please run the @coderabbitai full review command to re-trigger a full review.

---

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 generate interesting stats about this repository and render them as a table.
  -- @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 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.

Tip

Early access features: enabled

We are currently testing the following features in early access:

• OpenAI o1 for code reviews: OpenAI's new o1 model is being tested for code reviews. This model has advanced reasoning capabilities and can provide more nuanced feedback on your code.

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 on the discussion post.