Skip to content

chore: add CI workflow and repository polish#4

Merged
Sahithbasani merged 1 commit into
mainfrom
feature/add-ci-and-polish-readme
Jun 29, 2026
Merged

chore: add CI workflow and repository polish#4
Sahithbasani merged 1 commit into
mainfrom
feature/add-ci-and-polish-readme

Conversation

@Sahithbasani

Copy link
Copy Markdown
Owner

Overview

This pull request adds focused continuous-integration safeguards and small README improvements without restructuring or removing the existing engineering content.

Changes

  • Added .github/workflows/build.yml.

    • Runs for pushes to main and feature/** branches.
    • Runs for pull requests targeting main.
    • Installs the .NET 10 SDK explicitly.
    • Restores the solution and builds in Release configuration.
    • Treats compiler warnings as errors.
    • Uses read-only repository permissions.
  • Added .github/workflows/markdown-links.yml.

    • Runs when Markdown files change on main or in a pull request.
    • Supports manual execution through workflow_dispatch.
    • Checks repository Markdown links with Lychee.
    • Fails the workflow when broken links are detected.
    • Publishes the link-check result in the job summary.
  • Polished README.md.

    • Added build-status and Markdown-link-check badges.
    • Retained the existing C#, .NET 10, module, and license badges.
    • Changed the license badge to use repository license metadata.
    • Added an Engineering Quality section.
    • Documented CI scope, warning enforcement, documentation integrity, reproducible SDK setup, and the future testing policy.
    • Added Engineering Quality to the table of contents.

Validation

  • dotnet restore completed successfully.
  • ✅ Release build completed successfully.
  • ✅ Compiler warnings are treated as errors.
  • ✅ Build result: 0 warnings and 0 errors.
  • ✅ Existing module structure and internal Markdown links were validated.
  • ✅ All existing Microsoft documentation references returned successfully.
  • ℹ️ No test workflow was added because the repository currently has no test project. A test job should be introduced and required when tests are added.

Scope

  • 3 files changed
  • 90 insertions
  • 1 deletion
  • 1 commit ahead of main

Reviewer checklist

  • Confirm the build workflow triggers and succeeds.
  • Confirm the Markdown link workflow triggers for documentation changes.
  • Verify the README badges render after workflows are available on main.
  • Confirm branch-protection rules should require these checks before merging.

This PR intentionally contains no unrelated documentation rewrite, test placeholders, or changes to existing module content.

@Sahithbasani Sahithbasani merged commit a728e0b into main Jun 29, 2026
3 checks passed
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.

1 participant