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

fix/ci(workflows/pmd): fail build if pmd detects violations #2

Merged
merged 2 commits into from
Aug 21, 2024

Conversation

Baconing
Copy link
Member

@Baconing Baconing commented Aug 21, 2024

The PMD check does not fail if it detects more than one violation, this PR resolves that.

Summary by CodeRabbit

  • New Features
    • Enhanced error handling and reporting in the PMD GitHub Action workflow with a new "PMD failed" step to check for analysis outcomes.
    • Improved control flow by allowing conditional execution based on PMD analysis results.

@Baconing Baconing added the Kind/Bug Something is not working label Aug 21, 2024
@Baconing Baconing self-assigned this Aug 21, 2024
Copy link

coderabbitai bot commented Aug 21, 2024

Warning

Rate limit exceeded

@Baconing has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 10 minutes and 52 seconds before requesting another review.

How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

Commits

Files that changed from the base of the PR and between 9c0b238 and 12e8c50.

Walkthrough

The recent changes to the PMD GitHub Action workflow enhance its error handling and reporting capabilities. A new step titled "PMD failed" has been introduced to evaluate the outcome of the PMD analysis, allowing the workflow to react appropriately when violations are detected. By referencing the PMD analysis outputs, these modifications improve the overall control flow and reliability of the CI/CD process.

Changes

Files Change Summary
.github/workflows/pmd.yml Added a new step "PMD failed" to handle analysis outcomes; included id: pmd for referencing outputs.

Poem

In the garden where rabbits play,
A workflow danced in bright array.
With PMD checks both bold and keen,
It catches flaws that might be seen.
Errors feared, now swiftly caught,
Hooray for changes! Lessons taught! 🐇✨


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>.
    • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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 as 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.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 8883b9b and 9c0b238.

Files selected for processing (1)
  • .github/workflows/pmd.yml (1 hunks)
Additional context used
actionlint
.github/workflows/pmd.yml

31-31: step must run script with "run" section or run action with "uses" section

(syntax-check)

Additional comments not posted (1)
.github/workflows/pmd.yml (1)

25-29: LGTM! The addition of id: pmd is correct.

This change allows the subsequent step to reference the outputs from the PMD analysis.

.github/workflows/pmd.yml Show resolved Hide resolved
@Baconing Baconing merged commit 9c53720 into master Aug 21, 2024
1 of 2 checks passed
@Baconing Baconing deleted the pmd-viol-fix branch August 21, 2024 19:48
Baconing added a commit that referenced this pull request Sep 30, 2024
The PMD check does not fail if it detects more than one violation, this PR resolves that. (#2)
* fix/ci(workflows/pmd): fail build if pmd detects violations
* fix(ci/pmd): actually fail the check

---------

Signed-off-by: Bacon <[email protected]>
@Baconing Baconing added this to the Version: 2025-1.0.0 milestone Sep 30, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Kind/Bug Something is not working
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant