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: treat warnings as errors #14443

Merged
merged 1 commit into from
Jan 17, 2025
Merged

Conversation

mirkoSekulic
Copy link
Collaborator

@mirkoSekulic mirkoSekulic commented Jan 17, 2025

Description

@standeren has done a great job fixing all the warnings. We should treat warnings as errors from now on.
Pr only set's the rule for treating warnings as errors and fixes one warning.

Related Issue(s)

  • PR itself

Verification

  • Your code builds clean without any errors or warnings
  • Manual testing done (required)
  • Relevant automated test added (if you find this hard, leave it and we'll help out)

Documentation

  • User documentation is updated with a separate linked PR in altinn-studio-docs. (if applicable)

Copy link
Contributor

coderabbitai bot commented Jan 17, 2025

📝 Walkthrough

Walkthrough

The pull request introduces two distinct changes in the backend project. First, a project-wide configuration modification in Directory.Build.props enables treating compiler warnings as errors, which will enforce stricter code quality standards during builds. Second, an XML documentation comment has been added to the UserController constructor in the UserController.cs file, providing more explicit documentation for the userService parameter.

Changes

File Change Summary
backend/Directory.Build.props Added <TreatWarningsAsErrors>true</TreatWarningsAsErrors> to enforce compiler warnings as errors
backend/src/Designer/Controllers/UserController.cs Added XML documentation comment /// <param name="userService">User service</param> for the UserController constructor

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.

@github-actions github-actions bot added solution/studio/designer Issues related to the Altinn Studio Designer solution. backend labels Jan 17, 2025
@mirkoSekulic mirkoSekulic changed the title chore: treat warrnings as errors chore: treat warnings as errors Jan 17, 2025
@mirkoSekulic mirkoSekulic added the skip-manual-testing PRs that do not need to be tested manually label Jan 17, 2025
Copy link
Contributor

@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)
backend/src/Designer/Controllers/UserController.cs (1)

30-30: LGTM! Consider enhancing the documentation.

The added XML documentation addresses the compiler warning. While sufficient, consider adding more details about the service's role or responsibilities for better clarity.

Consider enhancing the documentation:

-        /// <param name="userService">User service</param>
+        /// <param name="userService">Service for managing user-related operations and permissions</param>
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 88bf0ba and 1643519.

📒 Files selected for processing (2)
  • backend/Directory.Build.props (1 hunks)
  • backend/src/Designer/Controllers/UserController.cs (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (6)
  • GitHub Check: Run dotnet build and test (macos-latest)
  • GitHub Check: Analyze
  • GitHub Check: Build environment and run e2e test
  • GitHub Check: Run dotnet build and test (windows-latest)
  • GitHub Check: Run dotnet build and test (ubuntu-latest)
  • GitHub Check: Run integration tests against actual gitea and db
🔇 Additional comments (1)
backend/Directory.Build.props (1)

7-9: LGTM! Important: Verify build status across solution.

This change will enforce stricter code quality by treating all compiler warnings as errors. While this is a good practice, it might initially cause build failures if there are existing warnings in the codebase.

Let's verify the potential impact by checking for existing compiler warnings:

✅ Verification successful

Verified: No active compiler warnings found, safe to proceed

The codebase appears to be clean from compiler warnings. The only warning suppressions found are:

  • Standard EF Core migration suppressions (auto-generated files)
  • One SonarQube rule (not a compiler warning)
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Search for existing compiler warning suppressions or warning annotations
rg -i "CS\d{4}" backend/
rg -i "#pragma warning" backend/

Length of output: 2505

@mirkoSekulic mirkoSekulic merged commit 400c8e2 into main Jan 17, 2025
19 checks passed
@mirkoSekulic mirkoSekulic deleted the chore/treat-warrnings-as-error branch January 17, 2025 08:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backend skip-manual-testing PRs that do not need to be tested manually solution/studio/designer Issues related to the Altinn Studio Designer solution. team/studio-core
Projects
Status: ✅ Done
Development

Successfully merging this pull request may close these issues.

2 participants