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

Development: Run GitHub coverage summary step only on success in default test pipeline #10186

Merged
merged 2 commits into from
Jan 30, 2025

Conversation

ole-ve
Copy link
Contributor

@ole-ve ole-ve commented Jan 21, 2025

Checklist

General

Motivation and Context

If the GitHub default test pipeline fails, no coverage report is generated and no summary can be created and uploaded. The step Append Per-Module Coverage to Job Summary fails then.

Note: Upload Server Test Coverage Report just ignores the non-existent reports with a warning instead of an upload failure.

Summary by CodeRabbit

  • Chores
    • Updated Jacoco coverage configuration to exclude Gradle-related files from test coverage reports.

@ole-ve ole-ve added the small label Jan 21, 2025
@ole-ve ole-ve self-assigned this Jan 21, 2025
@ole-ve ole-ve marked this pull request as ready for review January 21, 2025 23:26
@ole-ve ole-ve requested a review from a team as a code owner January 21, 2025 23:26
coderabbitai[bot]
coderabbitai bot previously approved these changes Jan 21, 2025
Copy link

coderabbitai bot commented Jan 21, 2025

Walkthrough

The pull request modifies the gradle/jacoco.gradle file by adding a new entry to the ignoredDirectories list. Specifically, the change instructs the Jacoco code coverage tool to exclude files located in the org/gradle directory from coverage reports. This adjustment helps refine the coverage reporting by preventing generated Gradle-related files from being included in the analysis.

Changes

File Change Summary
gradle/jacoco.gradle Added "**/org/gradle/**" to the list of ignored directories in Jacoco configuration

Suggested Labels

ready to merge, buildagent

Suggested Reviewers

  • SimonEntholzer
  • az108
  • krusche

Note: No sequence diagram was generated as the changes are minimal and do not involve significant control flow modifications.


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 or @coderabbitai title anywhere in the PR title to generate the title automatically.

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: 0

🧹 Nitpick comments (1)
gradle/jacoco.gradle (1)

89-89: Consider using more specific exclusion pattern.

The current pattern "**/org/gradle/**" might be too broad as it excludes everything under the org/gradle namespace. Consider making it more specific if you only want to exclude certain Gradle-generated files.

For example:

-        "**/org/gradle/**",
+        "**/org/gradle/api/**",  // Exclude only specific Gradle packages
📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between fad4249 and c04f29e.

⛔ Files ignored due to path filters (1)
  • .github/workflows/test.yml is excluded by !**/*.yml
📒 Files selected for processing (1)
  • gradle/jacoco.gradle (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (7)
  • GitHub Check: server-style
  • GitHub Check: client-tests
  • GitHub Check: client-style
  • GitHub Check: server-tests
  • GitHub Check: Build and Push Docker Image
  • GitHub Check: Analyse
  • GitHub Check: Build .war artifact

Copy link
Contributor

@cremertim cremertim left a comment

Choose a reason for hiding this comment

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

changes lgtm

Copy link
Contributor

@PaRangger PaRangger left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link
Contributor

@az108 az108 left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link
Contributor

@SimonEntholzer SimonEntholzer left a comment

Choose a reason for hiding this comment

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

lgtm 👍

Copy link
Contributor

@magaupp magaupp left a comment

Choose a reason for hiding this comment

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

Change looks good

@krusche krusche merged commit 1179759 into develop Jan 30, 2025
31 of 35 checks passed
@krusche krusche deleted the chore/conditional-coverage-summary branch January 30, 2025 19:58
@krusche krusche added this to the 7.9.1 milestone Jan 30, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Merged
Development

Successfully merging this pull request may close these issues.

7 participants