Create build.yml#866
Conversation
Reviewer's GuideAdds a GitHub Actions CI workflow that builds, tests, performs code coverage, and integrates with SonarCloud, Codecov, and Codacy for a .NET solution using CouchDB as a service container. Flow diagram for build · test · coverage GitHub Actions jobflowchart LR
A["push_or_pull_request_trigger"] --> B["start_build_test_coverage_job"]
B --> C["start_CouchDB_service_container"]
C --> D["checkout_repository"]
D --> E["setup_DotNet_10"]
E --> F["setup_Java_21"]
F --> G["install_GitVersion_tool"]
G --> H["determine_semantic_version_with_GitVersion"]
H --> I["patch_props_files_with_computed_version"]
I --> J["resolve_solution_name"]
J --> K["install_dotnet_sonarscanner_global_tool"]
K --> L["dotnet_restore"]
L --> M["resolve_Sonar_context_flags_internal_vs_fork"]
M --> N{"is_internal_branch_or_PR"}
N -->|yes| O["begin_SonarCloud_scan"]
N -->|no| P["skip_SonarCloud_begin"]
O --> Q["dotnet_build_solution"]
P --> Q
Q --> R["run_dotnet_test_for_each_project_with_coverage"]
R --> S["upload_JUnit_test_results_artifact"]
S --> T{"is_internal_branch_or_PR"}
T -->|yes| U["upload_coverage_to_Codecov"]
T -->|yes| V["report_coverage_to_Codacy"]
T -->|no| W["skip_external_coverage_reporting"]
U --> X["end_SonarCloud_scan_if_started"]
V --> X
W --> X
X --> Y["job_complete"]
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
gstraccini
Bot
added
the
☑️ auto-merge
github-actions
Bot
added
the
size/L
![gstraccini[bot]](https://avatars.githubusercontent.com/in/480132?s=60&v=4){kind=small}
|
Note Reviews pausedIt looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the Use the following commands to manage reviews:
Use the checkboxes below for quick actions:
WalkthroughAdds a new GitHub Actions workflow ChangesCI Workflow
Sequence Diagram(s)sequenceDiagram
actor GH as GitHub
participant Runner as "Actions Runner"
participant Repo as "Repository (checkout)"
participant CouchDB as "CouchDB 3.3.3"
participant Runtimes as "Java 17 / .NET 10.x"
participant Tools as "SonarScanner / DeepSource CLI"
participant Build as "dotnet restore/build/test"
participant Sonar as SonarCloud
participant Codecov as Codecov
participant DeepSource as DeepSource
GH->>Runner: Trigger (push / pull_request / workflow_dispatch)
Runner->>Repo: checkout (PR head SHA when applicable)
Runner->>CouchDB: start service (port 5984, healthcheck /_up)
Runner->>Runtimes: setup Java 17 and .NET 10.x
Runner->>Tools: install dotnet-sonarscanner and DeepSource CLI
Runner->>Build: dotnet restore -> dotnet build --no-restore -> dotnet test (collect coverage opencover,cobertura)
Build-->>Runner: coverage reports
Runner->>Sonar: dotnet sonarscanner begin ... end (analysis upload)
Runner->>Codecov: upload coverage (CODECOV_TOKEN)
Runner->>DeepSource: run ./bin/deepsource report (conditional on in-repo PR or dispatch)
CouchDB-->>Build: respond to test requests (health OK)
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Poem
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 inconclusive)
✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
There was a problem hiding this comment.
Hey - I've found 1 issue, and left some high level feedback:
- The coverage file paths are hard-coded to
coverage.net9.0.opencover.xmlin both SonarCloud and Codecov/Codacy steps, but the test command never setsCoverletOutputor the target framework in the path, so these uploads will likely fail—either align the test output naming to that path or make the reporting steps discover the generated files dynamically. - The CouchDB admin credentials are embedded directly in the workflow file; consider moving
COUCHDB_USERand especiallyCOUCHDB_PASSWORDto GitHub Action secrets or at least environment variables at the repository level to avoid hard-coding credentials in version control.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- The coverage file paths are hard-coded to `coverage.net9.0.opencover.xml` in both SonarCloud and Codecov/Codacy steps, but the test command never sets `CoverletOutput` or the target framework in the path, so these uploads will likely fail—either align the test output naming to that path or make the reporting steps discover the generated files dynamically.
- The CouchDB admin credentials are embedded directly in the workflow file; consider moving `COUCHDB_USER` and especially `COUCHDB_PASSWORD` to GitHub Action secrets or at least environment variables at the repository level to avoid hard-coding credentials in version control.
## Individual Comments
### Comment 1
<location path=".github/workflows/build.yml" line_range="28" />
<code_context>
+ image: couchdb:3.3.3
+ env:
+ COUCHDB_USER: Admin
+ COUCHDB_PASSWORD: myP@ssw0rd
+ ports:
+ - 5984:5984
</code_context>
<issue_to_address>
**🚨 issue (security):** Avoid committing a hard-coded database password, even for a test-only service container.
Even for CI-only containers, committing a real-looking password is poor security hygiene and can normalize the pattern elsewhere. Please switch to an obviously dummy value (e.g. `test-password`) and/or source it from a non-sensitive repo variable so no secrets appear directly in the workflow file.
</issue_to_address>Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (3)
.github/workflows/build.yml (3)
66-76: Note:FileVersionandInformationalVersionelements don't exist inDirectory.Build.props.The sed substitution only replaces existing elements. Since
Directory.Build.propslacks<FileVersion>and<InformationalVersion>elements, those patterns will be no-ops. This is likely fine since MSBuild can derive these from<Version>, but if explicit values are needed, you'll need to add them to the props file or modify the script to insert missing elements.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In @.github/workflows/build.yml around lines 66 - 76, The workflow patches .props using VERSION but the sed commands only replace existing tags so <FileVersion> and <InformationalVersion> in Directory.Build.props remain absent; update the script to ensure those elements exist or are inserted when missing: after computing VERSION (VERSION="${{ steps.gitversion.outputs.semVer }}") adjust the find|xargs|sed pipeline (the current sed -e replacements) to either (a) append missing <FileVersion>$VERSION</FileVersion> and <InformationalVersion>$VERSION</InformationalVersion> into files that lack them or (b) change the logic to generate a minimal props fragment with all four tags and write/merge it into Directory.Build.props, referencing the tags <Version>, <PackageVersion>, <AssemblyVersion>, <FileVersion>, and <InformationalVersion> so explicit values are present when required.
179-189: Consider pinning Codacy reporter version for reproducibility and security.Downloading
latestfrom GitHub releases on every run introduces supply chain risk and can cause unexpected breakages. Consider pinning to a specific version.🔒 Proposed fix to pin version
- name: Report coverage → Codacy if: steps.ctx.outputs.is_fork == 'false' run: | SLN="${{ steps.solution.outputs.name }}" + CODACY_VERSION="13.13.7" # Pin to specific version curl -fsSL \ - https://github.com/codacy/codacy-coverage-reporter/releases/latest/download/codacy-coverage-reporter-assembly.jar \ + "https://github.com/codacy/codacy-coverage-reporter/releases/download/${CODACY_VERSION}/codacy-coverage-reporter-assembly.jar" \ -o codacy-reporter.jar java -jar codacy-reporter.jar report \ -l CSharp \ -t "${{ secrets.CODACY_PROJECT_TOKEN }}" \ -r "Tests/${SLN}.Tests/coverage.net9.0.opencover.xml"🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In @.github/workflows/build.yml around lines 179 - 189, The workflow currently downloads the Codacy reporter using the `latest` release URL (in the "Report coverage → Codacy" step), which is brittle; change the download URL to a pinned release (replace the `.../releases/latest/.../codacy-coverage-reporter-assembly.jar` URL with a specific tag or versioned asset) and update any references to `codacy-reporter.jar` accordingly (you can add a variable like REPORTER_VERSION and use it in the curl URL and file name) so the `java -jar codacy-reporter.jar report` invocation uses a reproducible, versioned reporter.
78-84: Add error handling for missing solution file.If no
.slnfile is found, the script silently continues with an emptySLNvariable, which will cause confusing failures downstream (e.g., building".sln").🛠️ Proposed fix to add validation
- name: Resolve solution name id: solution run: | - SLN=$(find . -maxdepth 2 -name "*.sln" | head -1 | xargs basename -s .sln) + SLN_PATH=$(find . -maxdepth 2 -name "*.sln" | head -1) + if [[ -z "$SLN_PATH" ]]; then + echo "::error::No .sln file found within depth 2" + exit 1 + fi + SLN=$(basename -s .sln "$SLN_PATH") echo "name=$SLN" >> "$GITHUB_OUTPUT" echo "Solution: $SLN"🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In @.github/workflows/build.yml around lines 78 - 84, The "Resolve solution name" step sets SLN by finding a .sln but doesn't validate it; if none is found downstream steps will fail confusingly. After computing SLN in that step (variable SLN), add a check like if [ -z "$SLN" ]; then write a clear error to stderr (e.g., "No .sln file found in repo") and exit 1 so the workflow fails early; otherwise continue to echo "name=$SLN" >> "$GITHUB_OUTPUT" and the existing log line. Ensure the check references SLN and the step id (solution) so it's easy to locate.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In @.github/workflows/build.yml:
- Around line 134-142: Avoid directly interpolating the user-controlled
github.head_ref into the shell array; instead set it into a safe environment
variable in a previous step (e.g., echo "PR_HEAD_REF=${{ github.head_ref }}" >>
$GITHUB_ENV) and then reference that env var when building PARAMS (change the
entry in PARAMS from "/d:sonar.pullrequest.branch=${{ github.head_ref }}" to use
"/d:sonar.pullrequest.branch=${PR_HEAD_REF}" or "${PR_HEAD_REF}"). Update the
conditional block that constructs PARAMS (the PARAMS+=(...) lines) to use the
env var for head ref (and similarly protect any other user-provided values) so
no untrusted string is directly interpolated into the shell script.
---
Nitpick comments:
In @.github/workflows/build.yml:
- Around line 66-76: The workflow patches .props using VERSION but the sed
commands only replace existing tags so <FileVersion> and <InformationalVersion>
in Directory.Build.props remain absent; update the script to ensure those
elements exist or are inserted when missing: after computing VERSION
(VERSION="${{ steps.gitversion.outputs.semVer }}") adjust the find|xargs|sed
pipeline (the current sed -e replacements) to either (a) append missing
<FileVersion>$VERSION</FileVersion> and
<InformationalVersion>$VERSION</InformationalVersion> into files that lack them
or (b) change the logic to generate a minimal props fragment with all four tags
and write/merge it into Directory.Build.props, referencing the tags <Version>,
<PackageVersion>, <AssemblyVersion>, <FileVersion>, and <InformationalVersion>
so explicit values are present when required.
- Around line 179-189: The workflow currently downloads the Codacy reporter
using the `latest` release URL (in the "Report coverage → Codacy" step), which
is brittle; change the download URL to a pinned release (replace the
`.../releases/latest/.../codacy-coverage-reporter-assembly.jar` URL with a
specific tag or versioned asset) and update any references to
`codacy-reporter.jar` accordingly (you can add a variable like REPORTER_VERSION
and use it in the curl URL and file name) so the `java -jar codacy-reporter.jar
report` invocation uses a reproducible, versioned reporter.
- Around line 78-84: The "Resolve solution name" step sets SLN by finding a .sln
but doesn't validate it; if none is found downstream steps will fail
confusingly. After computing SLN in that step (variable SLN), add a check like
if [ -z "$SLN" ]; then write a clear error to stderr (e.g., "No .sln file found
in repo") and exit 1 so the workflow fails early; otherwise continue to echo
"name=$SLN" >> "$GITHUB_OUTPUT" and the existing log line. Ensure the check
references SLN and the step id (solution) so it's easy to locate.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 4b4c9f2d-3871-4a0c-8229-3286414b8bea
📒 Files selected for processing (1)
.github/workflows/build.yml
|
| GitGuardian id | GitGuardian status | Secret | Commit | Filename | |
|---|---|---|---|---|---|
| 13768420 | Triggered | Generic Password | 1cb5fdf | .github/workflows/build.yml | View secret |
🛠 Guidelines to remediate hardcoded secrets
- Understand the implications of revoking this secret by investigating where it is used in your code.
- Replace and store your secret safely. Learn here the best practices.
- Revoke and rotate this secret.
- If possible, rewrite git history. Rewriting git history is not a trivial act. You might completely break other contributing developers' workflow and you risk accidentally deleting legitimate data.
To avoid such incidents in the future consider
- following these best practices for managing and storing secrets including API keys and other credentials
- install secret detection on pre-commit to catch secret before it leaves your machine and ease remediation.
🦉 GitGuardian detects secrets in your source code to help developers and security teams secure the modern development process. You are seeing this because you or someone else with access to this repository has authorized GitGuardian to scan your pull request.
|
✅ Build CrispyWaffle 10.0.1273 completed (commit 655e10946e by @guibranco) |
PR Review 🔍
|
PR Code Suggestions ✨
|
|
✅ Build CrispyWaffle 10.0.1306 completed (commit 957cff2a88 by @gstraccini[bot]) |
Not up to standards ⛔🟢 Coverage
|
| Metric | Results |
|---|---|
| Coverage variation | ✅ +0.11% coverage variation (-1.00%) |
| Diff coverage | ✅ ∅ diff coverage |
Coverage variation details
Coverable lines Covered lines Coverage Common ancestor commit (6888d6d) 3681 1620 44.01% Head commit (5276ca7) 3681 (+0) 1624 (+4) 44.12% (+0.11%) Coverage variation is the difference between the coverage for the head and common ancestor commits of the pull request branch:
<coverage of head commit> - <coverage of common ancestor commit>
Diff coverage details
Coverable lines Covered lines Diff coverage Pull request (#866) 0 0 ∅ (not applicable) Diff coverage is the percentage of lines that are covered by tests out of the coverable lines that the pull request added or modified:
<covered lines added or modified>/<coverable lines added or modified> * 100%
TIP This summary will be updated as you push new changes. Give us feedback
|
✅ Build CrispyWaffle 10.0.1489 completed (commit 9d9236dc49 by @gstraccini[bot]) |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #866 +/- ##
==========================================
- Coverage 40.62% 40.53% -0.09%
==========================================
Files 83 83
Lines 3631 3631
Branches 519 519
==========================================
- Hits 1475 1472 -3
- Misses 2053 2055 +2
- Partials 103 104 +1 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
|
✅ Build CrispyWaffle 10.0.1508 completed (commit 83977bc500 by @gstraccini[bot]) |
|
❌ Build CrispyWaffle 10.0.1515 failed (commit 96e8549b01 by @gstraccini[bot]) |
|
❌ Build CrispyWaffle 10.0.1517 failed (commit afa4eb21e7 by @guibranco) |
|
❌ Build CrispyWaffle 10.0.1562 failed (commit b2d85cba57 by @gstraccini[bot]) |
|
❌ Build CrispyWaffle 10.0.1591 failed (commit 7cb1db1b42 by @gstraccini[bot]) |
|
❌ Build CrispyWaffle 10.0.1593 failed (commit ea7eb650b3 by @guibranco) |
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
|
❌ Build CrispyWaffle 10.0.1609 failed (commit 6d708fd189 by @gstraccini[bot]) |
|
❌ Build CrispyWaffle 10.0.1611 failed (commit 5bce1be0f4 by @guibranco) |
|
Infisical secrets check: ✅ No secrets leaked! 💻 Scan logs2026-05-19T13:01:07Z INF scanning for exposed secrets...
1:01PM INF 802 commits scanned.
2026-05-19T13:01:08Z INF scan completed in 1.29s
2026-05-19T13:01:08Z INF no leaks found
|
|
3 participants
User description
📑 Description
Create build.yml
✅ Checks
☢️ Does this introduce a breaking change?
Summary by Sourcery
Add a GitHub Actions workflow to build, test, and analyze the .NET solution on pushes and pull requests.
CI:
Summary by CodeRabbit
Description
Changes walkthrough 📝
build.yml
Implement CI Workflow for .NET Solution with Quality Checks.github/workflows/build.yml
solution.