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

chore: github workflows trigger branches #1688

Merged
merged 2 commits into from
Jan 10, 2025
Merged

Conversation

claytonneal
Copy link
Member

@claytonneal claytonneal commented Jan 10, 2025

Description

Update github workflow trigger branches to beyond just main branch

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • [] New feature (non-breaking change which adds functionality)
  • [] Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • [] This change requires a documentation update

How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration

  • Husky local tests

Test Configuration:

  • Node.js Version: 18.18.0

Checklist:

  • My code follows the coding standards of this project
  • I have performed a self-review of my code
  • I have commented on my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • New and existing integration tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules
  • I have not added any vulnerable dependencies to my code

Summary by CodeRabbit

  • Chores
    • Updated GitHub Actions workflows to expand branch coverage for automated checks
    • Added support for additional branch patterns in pull request and push triggers
    • Broadened leak detection and testing workflows to include main-*, supported-*, and feature-* branches

@claytonneal claytonneal requested a review from a team as a code owner January 10, 2025 10:03
Copy link

coderabbitai bot commented Jan 10, 2025

Walkthrough

The pull request introduces modifications to GitHub Actions workflow configurations across three files: .github/workflows/gitleaks.yml, .github/workflows/on-main.yml, and .github/workflows/on-pr.yml. The primary change involves expanding the branch trigger patterns to include not just the main branch, but also branches starting with main-, supported-, and feature-. This update broadens the scope of automated checks and workflows across different branch types, enabling more comprehensive monitoring and testing.

Changes

File Change Summary
.github/workflows/gitleaks.yml Updated branch triggers to include main, main-*, supported-*, and feature-* for leak detection
.github/workflows/on-main.yml Extended push event triggers to include supported-* and feature-* branches
.github/workflows/on-pr.yml Expanded pull request branch triggers to main, main-*, supported-*, and feature-*

Possibly related PRs

Suggested reviewers

  • saraantole

Poem

🐰 Branches dance, workflows expand,
From main to feature, a new command!
Gitleaks scanning, checks galore,
Our code's protection we explore
With patterns wide and workflows bright 🔍


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.

Copy link

@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

🧹 Nitpick comments (1)
.github/workflows/on-pr.yml (1)

6-9: LGTM! Consider updating documentation.

The branch pattern changes are consistent with other workflow files. Consider updating the repository's contributing guidelines or documentation to reflect these new branch naming patterns that are now supported in the CI/CD pipeline.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 96f66aa and 6887896.

📒 Files selected for processing (3)
  • .github/workflows/gitleaks.yml (1 hunks)
  • .github/workflows/on-main.yml (1 hunks)
  • .github/workflows/on-pr.yml (1 hunks)
🧰 Additional context used
🪛 yamllint (1.35.1)
.github/workflows/gitleaks.yml

[warning] 5-5: wrong indentation: expected 10 but found 8

(indentation)

⏰ Context from checks skipped due to timeout of 90000ms (12)
  • GitHub Check: rpc-proxy / test / test
  • GitHub Check: rpc-proxy / docker / docker
  • GitHub Check: unit-integration-test / Build & Lint (latest)
  • GitHub Check: unit-integration-test-browser / Build & Lint (latest)
  • GitHub Check: unit-integration-test / Build & Lint (lts/*)
  • GitHub Check: unit-integration-test-browser / Build & Lint (lts/*)
  • GitHub Check: unit-integration-test / Build & Lint (18)
  • GitHub Check: unit-integration-test-browser / Build & Lint (18)
  • GitHub Check: install-build / Build & Lint
  • GitHub Check: test-apps / Install and test example apps
  • GitHub Check: Execute doc examples
  • GitHub Check: Analyze (javascript-typescript)
🔇 Additional comments (2)
.github/workflows/on-main.yml (1)

8-9: Verify resource usage implications.

Running the main CI workflow (which includes build and all test suites) on feature branches could significantly increase CI minutes usage and potentially impact costs.

Let's analyze the current branch patterns and their activity:

✅ Verification successful

No immediate resource impact detected

The new branch patterns ('supported-' and 'feature-') are not currently in use, suggesting this is a proactive change. While there are no immediate resource implications, consider monitoring CI usage once these patterns become active.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Check the frequency and volume of matching branches to assess CI resource impact

# List all branches matching the new patterns
echo "Branches matching new patterns:"
git branch -r | grep -E 'supported-|feature-'

# Count commits in the last month for matching branches
echo -e "\nCommit frequency in the last month:"
for pattern in "supported-" "feature-"; do
  echo "Pattern: $pattern"
  git log --since="1 month ago" --format="%H" --all | while read commit; do
    git branch -r --contains $commit | grep $pattern
  done | sort | uniq -c | sort -nr
done

Length of output: 708


Script:

#!/bin/bash
# List remote branches matching the patterns
echo "Current branches matching patterns:"
git branch -r | grep -E 'origin/(supported|feature)-'

# Check recent git history for these patterns
echo -e "\nRecent commits on matching branches (last 30 days):"
git log --all --since="30 days ago" --format="%h %ad %s" --date=short | grep -E '(supported|feature)-'

Length of output: 255

.github/workflows/gitleaks.yml (1)

5-8: LGTM! Security checks on all branch types.

Expanding gitleaks checks to all branch types is a good security practice to catch potential secret leaks early.

🧰 Tools
🪛 yamllint (1.35.1)

[warning] 5-5: wrong indentation: expected 10 but found 8

(indentation)

@@ -2,7 +2,10 @@ name: Check for leaks in secrets
on:
pull_request:
branches:
- main
- 'main'
Copy link

Choose a reason for hiding this comment

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

🛠️ Refactor suggestion

Fix indentation for branch patterns.

The yamllint tool indicates incorrect indentation. Branch patterns should be indented with 10 spaces under branches:.

Apply this diff to fix the indentation:

    pull_request:
      branches:
-        - 'main'
+          - 'main'
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
- 'main'
- 'main'
🧰 Tools
🪛 yamllint (1.35.1)

[warning] 5-5: wrong indentation: expected 10 but found 8

(indentation)

Copy link

github-actions bot commented Jan 10, 2025

Test Coverage

Summary

Lines Statements Branches Functions
Coverage: 99%
98.98% (4370/4415) 97.48% (1393/1429) 99.01% (906/915)
Title Tests Skipped Failures Errors Time
core 836 0 💤 0 ❌ 0 🔥 2m 26s ⏱️
network 731 0 💤 0 ❌ 0 🔥 4m 58s ⏱️
errors 40 0 💤 0 ❌ 0 🔥 18.105s ⏱️
logging 3 0 💤 0 ❌ 0 🔥 19.652s ⏱️
hardhat-plugin 19 0 💤 0 ❌ 0 🔥 1m 1s ⏱️
aws-kms-adapter 23 0 💤 0 ❌ 0 🔥 1m 28s ⏱️
ethers-adapter 5 0 💤 0 ❌ 0 🔥 1m 17s ⏱️
rpc-proxy 37 0 💤 0 ❌ 0 🔥 1m 3s ⏱️

@fabiorigam fabiorigam merged commit 554c672 into main Jan 10, 2025
17 checks passed
@fabiorigam fabiorigam deleted the chore/workflow-triggers branch January 10, 2025 11:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants