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

Add 'develop' branch to workflow triggers #31

Merged
merged 1 commit into from
Feb 2, 2025
Merged

Conversation

klaasnicolaas
Copy link
Member

@klaasnicolaas klaasnicolaas commented Feb 2, 2025

Proposed change

Additional information

  • This PR fixes or closes issue: fixes #

Checklist

  • I have updated the documentation if needed.
  • I have updated the tests if needed.

Summary by CodeRabbit

  • Chores
    • Updated automation workflows so that actions now trigger on both primary and development branches, ensuring that release notes and labels remain in sync with updates from both streams.

@klaasnicolaas klaasnicolaas added the ci Work that improves the continue integration. label Feb 2, 2025
Copy link

coderabbitai bot commented Feb 2, 2025

📝 Walkthrough

Walkthrough

The pull request modifies two GitHub Actions workflow configurations by updating the push event triggers. Both the Release Drafter and Sync Labels workflows, which previously activated only on pushes to the main branch, are now set to also trigger on pushes to the develop branch.

Changes

File(s) Change Summary
.github/workflows/release-drafter.yaml,
.github/workflows/sync-labels.yaml
Added develop branch to push event triggers, expanding execution from main only

Sequence Diagram(s)

sequenceDiagram
    participant Dev as Developer
    participant GH as GitHub
    participant RD as Release Drafter Workflow
    participant SL as Sync Labels Workflow

    Dev->>GH: Push commit to branch (main or develop)
    GH->>RD: Evaluate push trigger for Release Drafter
    GH->>SL: Evaluate push trigger for Sync Labels
    alt Branch is main or develop
      RD->>GH: Initiate Release Drafter job
      SL->>GH: Initiate Sync Labels job
    else
      Note right of GH: No workflow triggered
    end
Loading

📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 05d14ca and 6b307b9.

📒 Files selected for processing (2)
  • .github/workflows/release-drafter.yaml (1 hunks)
  • .github/workflows/sync-labels.yaml (1 hunks)
🔇 Additional comments (4)
.github/workflows/release-drafter.yaml (2)

7-9: Correctly Extended Workflow Triggers

The addition of the develop branch in the list of branches under the push event now ensures that changes from both the main and develop branches will trigger the Release Drafter workflow. The YAML syntax is correct and aligns with the PR objective.


5-11: Consider Impact on Release Workflow

While extending triggers to develop is straightforward, please ensure that any branch-specific considerations—such as versioning or release notes generation—are checked so that releases drafted from develop are handled appropriately.

.github/workflows/sync-labels.yaml (2)

7-9: Expanded Workflow Trigger for Label Sync

Including the develop branch along with main under the push event trigger properly broadens the scope for the Sync Labels workflow. The configuration change is minimal and correct; it should allow label synchronization to run on both branches as intended.


4-13: Double-Check Branch-Specific Effects

As with the Release Drafter workflow, verify that triggering on develop does not inadvertently affect label syncing practices—especially if branch-specific label sets or environments are being managed. If there are nuances in how labels should be applied to develop, consider addressing that in documentation or further configuration.


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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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.

@klaasnicolaas klaasnicolaas merged commit d82babc into develop Feb 2, 2025
8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ci Work that improves the continue integration.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant