Skip to content

Improve README: TOC, required-files in intro, version in install, reorder sections, auto-update version in CI#69

Draft
Copilot wants to merge 2 commits intomainfrom
copilot/update-readme-and-release-workflow
Draft

Improve README: TOC, required-files in intro, version in install, reorder sections, auto-update version in CI#69
Copilot wants to merge 2 commits intomainfrom
copilot/update-readme-and-release-workflow

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Apr 7, 2026

README was missing a TOC, didn't mention required-files checking upfront, omitted the version from the install command (needed for preview releases), had sections in a suboptimal order, and ended with a redundant XSD Schema paragraph.

README

  • Intro: Added mention of required-files checking with glob wildcard support
  • TOC: Added linking all major sections
  • Installation: dotnet tool install -g slnx-validator --version 0.5.0 — version is required when the package is published as a pre-release
  • Section order: Usage → Options (--required-files first) → Exit codes (new dedicated section) → Example output → What is validated → Error codes → SonarQube example → GitHub Code Scanning example
  • Removed: Trailing ## XSD Schema section — the link is already present in "What is validated"

build.yml

Added Update README version step that runs after NuGet publish on main:

VERSION=$(grep -oP '<VersionPrefix>\K[^<]+' src/SLNX-validator/SLNX-validator.csproj)
sed -i "s|dotnet tool install -g slnx-validator --version [0-9]+\.[0-9]+\.[0-9]+|...$VERSION|g" README.md
  • Commits and pushes only when README actually changes (no-op if version unchanged)
  • Guards against empty VERSION extraction
  • Requires contents: write permission (changed from read)

Copilot AI and others added 2 commits April 7, 2026 21:50
…-update version in build workflow

Agent-Logs-Url: https://github.com/304NotModified/SLNX-validator/sessions/70301858-7e64-4f50-8b34-1cc6bbf0be0b

Co-authored-by: 304NotModified <5808377+304NotModified@users.noreply.github.com>
…update step

Agent-Logs-Url: https://github.com/304NotModified/SLNX-validator/sessions/70301858-7e64-4f50-8b34-1cc6bbf0be0b

Co-authored-by: 304NotModified <5808377+304NotModified@users.noreply.github.com>
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.

2 participants