Repository navigation
Implement PR Size Labeler - #1098
Conversation
|
Important Cloud Posse Engineering Team Review RequiredThis pull request modifies files that require Cloud Posse's review. Please be patient, and a core maintainer will review your changes. To expedite this process, reach out to us on Slack in the |
mergify
Bot
added
triage
📝 WalkthroughWalkthroughA new job called Changes
Sequence Diagram(s)sequenceDiagram
participant PR as Pull Request
participant GH as GitHub Actions Workflow
participant ACTION as codelytv/pr-size-labeler@v1
PR ->> GH: PR opened (active)
GH ->> ACTION: Execute pr-size-labeler job
ACTION -->> GH: Return label result based on size thresholds
GH ->> PR: Apply appropriate label and warning for extra large PRs
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? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
Documentation and Community
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
.github/workflows/codeql.yml (1)
84-91: Clean Up Trailing Whitespace in Multiline MessageStatic analysis identified trailing spaces on lines 88 and 90. Removing these trailing spaces will help maintain clean YAML formatting and avoid potential linting issues.
🧰 Tools
🪛 YAMLlint (1.35.1)
[error] 88-88: trailing spaces
(trailing-spaces)
[error] 90-90: trailing spaces
(trailing-spaces)
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
.github/workflows/codeql.yml(1 hunks)
🧰 Additional context used
🪛 YAMLlint (1.35.1)
.github/workflows/codeql.yml
[error] 88-88: trailing spaces
(trailing-spaces)
[error] 90-90: trailing spaces
(trailing-spaces)
⏰ Context from checks skipped due to timeout of 90000ms (3)
- GitHub Check: Build (windows-latest, windows)
- GitHub Check: Analyze (go)
- GitHub Check: Summary
🔇 Additional comments (1)
.github/workflows/codeql.yml (1)
64-92: New PR Size Labeler Job Implementation and ConfigurationThe new job
pr-size-labeleris well integrated into the workflow. It correctly limits execution to open pull requests by using the proper condition and runs on an Ubuntu runner. The size thresholds for XS, S, M, L, and the extra-large settings (with a warning message) are clearly defined and align with the PR objectives of categorizing PR sizes for smoother reviews.🧰 Tools
🪛 YAMLlint (1.35.1)
[error] 88-88: trailing spaces
(trailing-spaces)
[error] 90-90: trailing spaces
(trailing-spaces)
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
.github/workflows/codeql.yml (2)
64-107: New PR Size Labeler Job Addition
The configuration for the new PR Size Labeler job looks solid with clear threshold definitions and a thoughtful warning message. One suggestion: if the intent is to run this job only on open pull requests, consider refining the condition fromif: github.event_name == 'pull_request'to something like
if: github.event.pull_request.state == 'open'This would ensure the job skips closed pull requests.
🧰 Tools
🪛 YAMLlint (1.35.1)
[error] 78-78: trailing spaces
(trailing-spaces)
[error] 103-103: trailing spaces
(trailing-spaces)
[error] 105-105: trailing spaces
(trailing-spaces)
78-78: Remove Trailing Whitespaces
YAML lint has flagged trailing spaces on lines 78, 103, and 105. Removing these will help maintain clean formatting.Also applies to: 103-103, 105-105
🧰 Tools
🪛 YAMLlint (1.35.1)
[error] 78-78: trailing spaces
(trailing-spaces)
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
.github/workflows/codeql.yml(1 hunks)
🧰 Additional context used
🪛 YAMLlint (1.35.1)
.github/workflows/codeql.yml
[error] 78-78: trailing spaces
(trailing-spaces)
[error] 103-103: trailing spaces
(trailing-spaces)
[error] 105-105: trailing spaces
(trailing-spaces)
⏰ Context from checks skipped due to timeout of 90000ms (3)
- GitHub Check: Build (windows-latest, windows)
- GitHub Check: Analyze (go)
- GitHub Check: Summary
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (3)
.github/workflows/codeql.yml (3)
80-80: Remove Trailing Whitespace on Line 80There's a trailing space at the end of the line that sets the
refparameter. Please remove the trailing whitespace to clean up the YAML formatting.- ref: ${{ github.event.pull_request.head.sha }} + ref: ${{ github.event.pull_request.head.sha }}🧰 Tools
🪛 YAMLlint (1.35.1)
[error] 80-80: trailing spaces
(trailing-spaces)
102-102: Remove Trailing Whitespace on Line 102A trailing space exists at the end of this line in the multiline message. Removing it will improve the file's cleanliness.
- > Large PRs are difficult to review and may be rejected due to their size. + > Large PRs are difficult to review and may be rejected due to their size.🧰 Tools
🪛 YAMLlint (1.35.1)
[error] 102-102: trailing spaces
(trailing-spaces)
104-104: Remove Trailing Whitespace on Line 104This line of the warning message also has unwanted trailing whitespace. Please remove it to maintain a consistent format.
- > Please verify that this PR does not address multiple issues. + > Please verify that this PR does not address multiple issues.🧰 Tools
🪛 YAMLlint (1.35.1)
[error] 104-104: trailing spaces
(trailing-spaces)
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
.github/workflows/codeql.yml(1 hunks)
🧰 Additional context used
🪛 YAMLlint (1.35.1)
.github/workflows/codeql.yml
[error] 80-80: trailing spaces
(trailing-spaces)
[error] 102-102: trailing spaces
(trailing-spaces)
[error] 104-104: trailing spaces
(trailing-spaces)
⏰ Context from checks skipped due to timeout of 90000ms (2)
- GitHub Check: Build (windows-latest, windows)
- GitHub Check: Summary
🔇 Additional comments (1)
.github/workflows/codeql.yml (1)
65-105: New PR Size Labeler Job Integration Looks SolidThe new
pr-size-labelerjob is well-configured to run only for pull requests. The job correctly checks out the repository using the pull request head SHA and passes all anticipated inputs to thecodelytv/pr-size-labeler@v1action. The thresholds and labels are clear and meet the PR objectives for categorizing pull request sizes.🧰 Tools
🪛 YAMLlint (1.35.1)
[error] 80-80: trailing spaces
(trailing-spaces)
[error] 102-102: trailing spaces
(trailing-spaces)
[error] 104-104: trailing spaces
(trailing-spaces)
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (3)
.github/workflows/codeql.yml (3)
75-80: Checkout Repository StepThe checkout step uses
actions/checkout@v4with a full history fetch (viafetch-depth: 0) and checks out the PR head commit. This ensures that the labeler operates on the correct code revision. Note: static analysis flagged trailing spaces on line 80; please remove them to comply with YAML lint guidelines.🧰 Tools
🪛 YAMLlint (1.35.1)
[error] 80-80: trailing spaces
(trailing-spaces)
105-105: Trailing Spaces in Warning MessageStatic analysis detected trailing spaces on line 105 within the
message_if_xlblock. Please remove these trailing spaces to adhere to YAML linting conventions.🧰 Tools
🪛 YAMLlint (1.35.1)
[error] 105-105: trailing spaces
(trailing-spaces)
107-107: Trailing Spaces in Warning Message ContinuationSimilarly, trailing spaces on line 107 need to be removed. Ensuring clean formatting here enhances maintainability and reduces linting errors.
🧰 Tools
🪛 YAMLlint (1.35.1)
[error] 107-107: trailing spaces
(trailing-spaces)
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
.github/workflows/codeql.yml(1 hunks)
🧰 Additional context used
🪛 YAMLlint (1.35.1)
.github/workflows/codeql.yml
[error] 80-80: trailing spaces
(trailing-spaces)
[error] 105-105: trailing spaces
(trailing-spaces)
[error] 107-107: trailing spaces
(trailing-spaces)
⏰ Context from checks skipped due to timeout of 90000ms (3)
- GitHub Check: Build (windows-latest, windows)
- GitHub Check: Analyze (go)
- GitHub Check: Summary
🔇 Additional comments (2)
.github/workflows/codeql.yml (2)
65-73: Job Definition for PR Size LabelerThe new job configuration for
pr-size-labeleris well-defined. The conditionif: github.event_name == 'pull_request'appropriately restricts this job to execute only on pull requests, and the permissions (contents: read, pull-requests: write, issues: write) are correctly set up.
81-109: PR Size Labeler Step ConfigurationThe step that invokes
codelytv/pr-size-labeler@v1is configured with comprehensive parameters. The thresholds for extra small through large PR sizes and the detailed warning message for extra large PRs are clearly laid out. The use of multi-line strings for bothfiles_to_ignoreandmessage_if_xlis consistent with earlier recommendations.🧰 Tools
🪛 YAMLlint (1.35.1)
[error] 105-105: trailing spaces
(trailing-spaces)
[error] 107-107: trailing spaces
(trailing-spaces)
Erik Osterman (Cloud Posse) (osterman)
added
the
no-release
* added PR size labeler * fix permissions * fix permissions * Apply suggestions from code review --------- Co-authored-by: Erik Osterman (CEO @ Cloud Posse) <erik@cloudposse.com>
|
These changes were released in v1.165.0. |
* fix permissions * codecov * Implement PR Size Labeler (#1098) * added PR size labeler * fix permissions * fix permissions * Apply suggestions from code review --------- Co-authored-by: Erik Osterman (CEO @ Cloud Posse) <erik@cloudposse.com> * Use Mergify for PR Size Comments (#1099) * fix comment and line breaks * comment test * test changes * this should not trigger another one * fix multiple msg * fix multiple msg * remove test file * Update .github/workflows/codeql.yml Co-authored-by: Erik Osterman (CEO @ Cloud Posse) <erik@cloudposse.com> * add test file * delete test file --------- Co-authored-by: Erik Osterman (CEO @ Cloud Posse) <erik@cloudposse.com> * fix: coverage run * clean up codecov * fix path * add comment * add comment * fix path debug * fix path part 2 * test config cov * test config cov * test config cov * test config cov * test codecov config * update ci * Update codecov.yml Co-authored-by: Erik Osterman (CEO @ Cloud Posse) <erik@cloudposse.com> * remove coverage file * unify tests * fix action codecov issue * Update codecov.yml Co-authored-by: Erik Osterman (CEO @ Cloud Posse) <erik@cloudposse.com> * Update .github/workflows/test.yml * Update test.yml * Update test.yml * Update codecov.yml --------- Co-authored-by: Erik Osterman (CEO @ Cloud Posse) <erik@cloudposse.com>
2 participants
what
PR Size Labeler will run on every open pull request
why
This is required to defined the PR sizes
references
Summary by CodeRabbit