Added block branch creation from staging

[ImeshRanawellaSG]

Summary by CodeRabbit

• New Features
  • Introduced an automated process that enforces branch creation guidelines, ensuring branches aren’t inadvertently based on restricted base branches. This change enhances the workflow consistency and safeguards the repository from non-compliant branch origins.

[coderabbitai]

Walkthrough

A new GitHub Actions workflow file has been added to block branch creation from a branch with a base ending in "-staging". The workflow triggers on branch creation events, retrieves the current and base branch references from the event context, and then checks if the base branch is derived from staging. Depending on the evaluation, it logs a corresponding message and either allows or prevents the branch creation.

Changes

File	Change Summary
.github/workflows/block_branch_creation_from_staging.yml	Introduces a workflow to prevent branch creation when the base branch reference ends with "-staging".

Sequence Diagram(s)

sequenceDiagram
    participant Developer as Developer
    participant GitHub as GitHub Actions
    participant Job as prevent-from-staging Job
    participant Logger as Logger

    Developer->>GitHub: Create new branch
    GitHub->>Job: Trigger workflow on branch creation
    Job->>Job: Retrieve current and base branch references
    alt Base branch reference not available
        Job->>Logger: Log message and exit successfully
    else Base branch reference ends with "-staging"
        Job->>Logger: Log error message and exit with failure
    else Other branch creation
        Job->>Logger: Log permitted branch creation and exit successfully
    end

Loading

---

🪧 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 plan to trigger planning for file edits and PR creation.
• @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]

Actionable comments posted: 1

🧹 Nitpick comments (1)

.github/workflows/block_branch_creation_from_staging.yml (1)

3-7: Review Branch Filter Usage for Create Events

The workflow currently specifies a branches filter (lines 5–6) under the create event. However, GitHub Actions does not support branch filtering for the create event (as noted by actionlint), so this filter will not have any effect. Consider removing it or revisiting the event trigger if you intend to restrict branch creation based on branch names.

🧰 Tools

🪛 actionlint (1.7.4)

5-5: "branches" filter is not available for create event. it is only for merge_group, push, pull_request, pull_request_target, workflow_run events

(events)

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between c3565dc and 166f2c1.

📒 Files selected for processing (1)

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

🧰 Additional context used

🪛 actionlint (1.7.4)

.github/workflows/block_branch_creation_from_staging.yml

5-5: "branches" filter is not available for create event. it is only for merge_group, push, pull_request, pull_request_target, workflow_run events

(events)