Skip to content

frist - #512

Merged
ignatandrei merged 4 commits into
mainfrom
480-httpsgithubcomjanusmaelbennewitzninjaautoversioning
Jul 16, 2026
Merged

frist#512
ignatandrei merged 4 commits into
mainfrom
480-httpsgithubcomjanusmaelbennewitzninjaautoversioning

Conversation

@ignatandrei

@ignatandrei ignatandrei commented Jul 16, 2026

Copy link
Copy Markdown
Owner

Summary by CodeRabbit

  • New Features

    • Added the Bennewitz.Ninja.AutoVersioning Roslyn source generator example, including a runnable project, guided tour, and walkthrough content.
  • Documentation

    • Added new generator documentation and metadata (including requirements, configuration, generated outputs, diagnostics, and local build instructions).
    • Updated the examples catalog to 277 items, added the new generator to relevant lists/cards/flowcharts, and refreshed “Latest Update” dates to July 4, 2026.

Copilot AI review requested due to automatic review settings July 16, 2026 15:59
@ignatandrei ignatandrei linked an issue Jul 16, 2026 that may be closed by this pull request
@coderabbitai

coderabbitai Bot commented Jul 16, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: d7f58bc9-d5c3-4ca7-8975-76cf3cb2c155

📥 Commits

Reviewing files that changed from the base of the PR and between c950d2a and ff9c4b7.

📒 Files selected for processing (2)
  • v2/Generator/MultiGeneratorV2.cs
  • v2/rscg_examples_site/docs/RSCG-Examples/Bennewitz.Ninja.AutoVersioning.md
🚧 Files skipped from review as they are similar to previous changes (1)
  • v2/rscg_examples_site/docs/RSCG-Examples/Bennewitz.Ninja.AutoVersioning.md

📝 Walkthrough

Walkthrough

Adds the 277th Roslyn source generator example, Bennewitz.Ninja.AutoVersioning, with metadata, documentation, a runnable .NET sample, walkthrough assets, and updates to repository and website catalogs.

Changes

Bennewitz AutoVersioning example

Layer / File(s) Summary
Generator metadata and documentation
v2/rscg_examples/Bennewitz.Ninja.AutoVersioning/*
Adds generator metadata, package description, configuration documentation, generated output examples, diagnostics, CI mappings, and local packaging instructions.
Runnable sample and walkthrough
v2/rscg_examples/Bennewitz.Ninja.AutoVersioning/src/*, v2/.tours/*, v2/rscg_examples/Bennewitz.Ninja.AutoVersioning/video.json
Adds a net10.0 console project configured for AutoVersioning, prints DirectoryBuildInfo.BuildRelease, and defines interactive tour scripts.
Catalog and top-level listings
v2/RSCGExamplesData/GeneratorDataRec.json, README.md, later.md
Registers the generator and updates the repository’s example count, generated details, and latest-update date.
Website pages and exports
v2/rscg_examples_site/docs/*, v2/rscg_examples_site/src/*, v2/rscg_examples_site/static/exports/RSCG.json
Adds author and generator documentation, updates category and total counts, and exports the new generator metadata.
Generated README link rewriting
v2/Generator/MultiGeneratorV2.cs
Updates generated README processing to prefix three template references with the generator source path.

Estimated code review effort: 3 (Moderate) | ~25 minutes

Sequence Diagram(s)

sequenceDiagram
  participant Project as InfoPrj.csproj
  participant Generator as Bennewitz.Ninja.AutoVersioning
  participant Sources as Generated source files
  participant App as Program.cs
  Project->>Generator: Supply versioning and assembly properties
  Generator->>Sources: Generate assembly metadata and DirectoryBuildInfo
  App->>Sources: Read DirectoryBuildInfo.BuildRelease
  Sources-->>App: Provide generated build value
Loading

Possibly related PRs

🚥 Pre-merge checks | ✅ 3 | ❌ 2

❌ Failed checks (1 warning, 1 inconclusive)

Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Write docstrings for the functions missing them to satisfy the coverage threshold.
Title check ❓ Inconclusive The title is too vague and misspelled, so it does not meaningfully describe the added Bennewitz.Ninja.AutoVersioning content. Replace it with a concise, specific title like "Add Bennewitz.Ninja.AutoVersioning example and docs".
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch 480-httpsgithubcomjanusmaelbennewitzninjaautoversioning

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Adds a new RSCG example for Bennewitz.Ninja.AutoVersioning and wires it into the v2 data pipeline + documentation site so it appears in lists, category pages, exports, and counts.

Changes:

  • Introduces a new example project (InfoPrj) demonstrating DirectoryBuildInfo.BuildRelease.
  • Adds the generator metadata and documentation pages/exports so the site lists the new example (277 total).
  • Updates “latest update” dates and category/author indexes to include the new entry.

Reviewed changes

Copilot reviewed 21 out of 23 changed files in this pull request and generated 3 comments.

Show a summary per file
File Description
v2/RSCGExamplesData/GeneratorDataRec.json Adds the generator to the core v2 generator registry data.
v2/rscg_examples/Bennewitz.Ninja.AutoVersioning/video.json Adds the scripted video steps for the example.
v2/rscg_examples/Bennewitz.Ninja.AutoVersioning/src/InfoPrj/Program.cs Minimal runtime demo printing the generated build version constant.
v2/rscg_examples/Bennewitz.Ninja.AutoVersioning/src/InfoPrj/InfoPrj.csproj Adds the package reference and MSBuild properties used by the generator.
v2/rscg_examples/Bennewitz.Ninja.AutoVersioning/src/InfoPrj.slnx Solution wrapper for the example project.
v2/rscg_examples/Bennewitz.Ninja.AutoVersioning/readme.txt Captures the upstream readme content for the example.
v2/rscg_examples/Bennewitz.Ninja.AutoVersioning/nuget.txt Short description used by the site/docs generator.
v2/rscg_examples/Bennewitz.Ninja.AutoVersioning/description.json Metadata describing how the site should present the example.
v2/rscg_examples_site/static/exports/RSCG.json Adds the new entry to the exported JSON list.
v2/rscg_examples_site/src/components/HomepageFeatures/index.js Updates the homepage example count (276 → 277).
v2/rscg_examples_site/docs/RSCG-Examples/index.md Updates counts and links for the new example in the category list.
v2/rscg_examples_site/docs/RSCG-Examples/Bennewitz.Ninja.AutoVersioning.md Adds the dedicated documentation page for the generator.
v2/rscg_examples_site/docs/indexRSCG.md Updates the chronological index and counts (276 → 277).
v2/rscg_examples_site/docs/Categories/EnhancementProject.md Updates category count and inserts the new generator into the list.
v2/rscg_examples_site/docs/Categories/_PrimitiveEnhancementProject.mdx Updates the category primitive list used for cross-linking.
v2/rscg_examples_site/docs/Authors/Brian_Bennewitz.md Adds an author index page for the new generator author.
v2/rscg_examples_site/docs/about.md Updates the “about” page count (276 → 277).
v2/Generator/all.csv Adds the generator to the CSV used to drive generation/exports.
v2/.tours/Bennewitz.Ninja.AutoVersioning.tour Adds a VS Code CodeTour for the new example.
README.md Updates repo-level counts and “Latest Update” date and adds the new entry.
later.md Updates “Latest Update” date.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

"show": true
},
{
"ID":"Bennewitz.Ninja.AutoVersioning",
Comment on lines +35 to +36
{"typeStep":"browser","arg":"https://ignatandrei.github.io/RSCG_Examples/v2/docs/Bennewitz.Ninja.AutoVersioning#download-example-net--c-",
SpeakTest=" "},
Comment on lines +14 to +17
"file": "rscg_examples/Bennewitz.Ninja.AutoVersioning/src/InfoPrj/Program.cs",
"description": "File Program.cs \r\n>> dotnet run --project rscg_examples/Bennewitz.Ninja.AutoVersioning/src/InfoPrj/InfoPrj.csproj ",
"pattern": "this is the code"
}

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🧹 Nitpick comments (1)
v2/rscg_examples_site/docs/indexRSCG.md (1)

23-23: 📐 Maintainability & Code Quality | 🔵 Trivial | 💤 Low value

Remove space inside link text.

There is a trailing space inside the Markdown link brackets that triggers a markdownlint warning.

🧹 Proposed fix
-|277| [Bennewitz.Ninja.AutoVersioning by Brian Bennewitz ](/docs/Bennewitz.Ninja.AutoVersioning)|2026-07-04 => 04 July 2026 | [EnhancementProject](/docs/Categories/EnhancementProject) |
+|277| [Bennewitz.Ninja.AutoVersioning by Brian Bennewitz](/docs/Bennewitz.Ninja.AutoVersioning)|2026-07-04 => 04 July 2026 | [EnhancementProject](/docs/Categories/EnhancementProject) |
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@v2/rscg_examples_site/docs/indexRSCG.md` at line 23, Remove the trailing
space from the Markdown link text for “Bennewitz.Ninja.AutoVersioning” in the
project listing, keeping the link target and surrounding table content
unchanged.

Source: Linters/SAST tools

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@v2/rscg_examples/Bennewitz.Ninja.AutoVersioning/video.json`:
- Around line 35-36: Correct the malformed property definition in the JSON
object by using valid JSON syntax: quote the property name and separate it from
its value with a colon instead of an equals sign. Preserve the existing property
value and surrounding object structure.

---

Nitpick comments:
In `@v2/rscg_examples_site/docs/indexRSCG.md`:
- Line 23: Remove the trailing space from the Markdown link text for
“Bennewitz.Ninja.AutoVersioning” in the project listing, keeping the link target
and surrounding table content unchanged.
🪄 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: defaults

Review profile: CHILL

Plan: Pro

Run ID: 7fcba257-6f2d-44f9-93b6-0651cbdee975

📥 Commits

Reviewing files that changed from the base of the PR and between 0c73fe3 and c950d2a.

⛔ Files ignored due to path filters (3)
  • v2/Generator/all.csv is excluded by !**/*.csv
  • v2/rscg_examples_site/static/exports/RSCG.xlsx is excluded by !**/*.xlsx
  • v2/rscg_examples_site/static/sources/Bennewitz.Ninja.AutoVersioning.zip is excluded by !**/*.zip
📒 Files selected for processing (20)
  • README.md
  • later.md
  • v2/.tours/Bennewitz.Ninja.AutoVersioning.tour
  • v2/RSCGExamplesData/GeneratorDataRec.json
  • v2/rscg_examples/Bennewitz.Ninja.AutoVersioning/description.json
  • v2/rscg_examples/Bennewitz.Ninja.AutoVersioning/nuget.txt
  • v2/rscg_examples/Bennewitz.Ninja.AutoVersioning/readme.txt
  • v2/rscg_examples/Bennewitz.Ninja.AutoVersioning/src/InfoPrj.slnx
  • v2/rscg_examples/Bennewitz.Ninja.AutoVersioning/src/InfoPrj/InfoPrj.csproj
  • v2/rscg_examples/Bennewitz.Ninja.AutoVersioning/src/InfoPrj/Program.cs
  • v2/rscg_examples/Bennewitz.Ninja.AutoVersioning/video.json
  • v2/rscg_examples_site/docs/Authors/Brian_Bennewitz.md
  • v2/rscg_examples_site/docs/Categories/EnhancementProject.md
  • v2/rscg_examples_site/docs/Categories/_PrimitiveEnhancementProject.mdx
  • v2/rscg_examples_site/docs/RSCG-Examples/Bennewitz.Ninja.AutoVersioning.md
  • v2/rscg_examples_site/docs/RSCG-Examples/index.md
  • v2/rscg_examples_site/docs/about.md
  • v2/rscg_examples_site/docs/indexRSCG.md
  • v2/rscg_examples_site/src/components/HomepageFeatures/index.js
  • v2/rscg_examples_site/static/exports/RSCG.json

Comment on lines +35 to +36
{"typeStep":"browser","arg":"https://ignatandrei.github.io/RSCG_Examples/v2/docs/Bennewitz.Ninja.AutoVersioning#download-example-net--c-",
SpeakTest=" "},

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

🎯 Functional Correctness | 🔴 Critical | ⚡ Quick win

Fix invalid JSON syntax.

The property definition uses an equals sign and an unquoted key, which completely breaks JSON parsing.

🐛 Proposed fix
     {"typeStep":"browser","arg":"https://ignatandrei.github.io/RSCG_Examples/v2/docs/Bennewitz.Ninja.AutoVersioning#download-example-net--c-",
-    SpeakTest=" "},
+    "SpeakTest": " "},
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
{"typeStep":"browser","arg":"https://ignatandrei.github.io/RSCG_Examples/v2/docs/Bennewitz.Ninja.AutoVersioning#download-example-net--c-",
SpeakTest=" "},
{"typeStep":"browser","arg":"https://ignatandrei.github.io/RSCG_Examples/v2/docs/Bennewitz.Ninja.AutoVersioning#download-example-net--c-",
"SpeakTest": " "},
🧰 Tools
🪛 Biome (2.5.3)

[error] 36-36: Property key must be double quoted

(parse)


[error] 36-36: unexpected character =

(parse)


[error] 36-36: expected , but instead found " "

(parse)


[error] 36-36: expected : but instead found }

(parse)

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@v2/rscg_examples/Bennewitz.Ninja.AutoVersioning/video.json` around lines 35 -
36, Correct the malformed property definition in the JSON object by using valid
JSON syntax: quote the property name and separate it from its value with a colon
instead of an equals sign. Preserve the existing property value and surrounding
object structure.

Source: Linters/SAST tools

@ignatandrei
ignatandrei merged commit 4240e78 into main Jul 16, 2026
3 checks passed
@ignatandrei
ignatandrei deleted the 480-httpsgithubcomjanusmaelbennewitzninjaautoversioning branch July 16, 2026 16:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

https://github.com/JanusMael/Bennewitz.Ninja.AutoVersioning

2 participants