Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ci: run devcontainers workflow only on push to master #2295

Merged
merged 1 commit into from
Nov 6, 2024

Conversation

shumkov
Copy link
Member

@shumkov shumkov commented Oct 30, 2024

Issue being fixed or feature implemented

Currently, a long devcontainers worflow is running in case if related files are changed on push to any branch

What was done?

  • Trigger workflow only on push to master

How Has This Been Tested?

None

Breaking Changes

None

Checklist:

  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have added or updated relevant unit/integration/functional/e2e tests
  • I have added "!" to the title and described breaking changes in the corresponding section if my code contains any
  • I have made corresponding changes to the documentation if needed

For repository code-owners and collaborators only

  • I have assigned this pull request to a milestone

Summary by CodeRabbit

  • Chores
    • Updated GitHub Actions workflow to restrict prebuild triggers to the master branch only.

Copy link
Contributor

coderabbitai bot commented Oct 30, 2024

Walkthrough

The pull request modifies the GitHub Actions workflow configuration for prebuilding development containers. It updates the push event trigger to restrict execution to only the master branch, alongside existing path filters. This change allows for better control over the workflow's execution conditions, ensuring it only activates for the specified branch.

Changes

File Path Change Summary
.github/workflows/prebuild-devcontainers.yml Updated push event to include branches: - master

Possibly related PRs

  • ci: prebuild dev containers #2184: Introduces a new GitHub Actions workflow file named prebuild-devcontainers.yml, which is directly related to the changes made in the main PR that modifies the same workflow file to restrict triggers to the master branch.

Poem

In the garden where devs play,
A workflow change brightens the day.
With pushes to master, oh what a sight,
Prebuilds now run, just right!
Hopping along, we code with cheer,
For every branch, we hold dear! 🐇✨


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 5d82eca and db38a81.

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

10-11: LGTM! The branch restriction is properly implemented.

The change correctly restricts the workflow to run only on pushes to the master branch while maintaining the path filters. This optimization will help reduce unnecessary workflow executions.

Let's verify that this is the only workflow building devcontainers and that we're not missing similar optimizations in related workflows:

✅ Verification successful

Branch restriction is correctly implemented and no other workflows are affected

The verification confirms that:

  • .github/workflows/prebuild-devcontainers.yml is the only workflow handling devcontainer-related tasks
  • It's also the only workflow using path-based triggers that could benefit from branch restrictions
  • The branch restriction implementation is properly done without impacting other workflows
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check for other workflows that might be building devcontainers
# or using similar path triggers that could benefit from branch restrictions

# Search for workflows with devcontainer-related paths or jobs
rg -l --type yaml 'devcontainer|\.devcontainer' .github/workflows/

# Search for workflows with similar path-based triggers that might need branch restrictions
rg -A 5 'on:\s*\n\s*push:\s*\n\s*paths:' .github/workflows/

Length of output: 367


Script:

#!/bin/bash
# Let's fix the regex and try again with proper multiline support

# Search for workflows with devcontainer-related paths or jobs
echo "=== Devcontainer-related workflows ==="
rg -l --type yaml 'devcontainer|\.devcontainer' .github/workflows/

# Search for workflows with path-based triggers using multiline mode
echo -e "\n=== Workflows with path-based triggers ==="
rg -U -A 5 '^on:[\s\n]+push:[\s\n]+paths:' .github/workflows/

Length of output: 891


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

@shumkov shumkov requested a review from lklimek October 30, 2024 13:39
@shumkov shumkov changed the base branch from v1.4-dev to v1.6-dev November 1, 2024 01:53
@shumkov shumkov merged commit ae97f47 into v1.6-dev Nov 6, 2024
20 checks passed
@shumkov shumkov deleted the ci/devcontainers-only-master branch November 6, 2024 14:56
@shumkov shumkov mentioned this pull request Nov 6, 2024
20 tasks
@shumkov shumkov self-assigned this Nov 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

2 participants