Skip to content

fix: align build pipeline with TemplateDotNetTool patterns#142

Merged
Malcolmnixon merged 3 commits intomainfrom
copilot/fix-build-pipeline-comments
Feb 19, 2026
Merged

fix: align build pipeline with TemplateDotNetTool patterns#142
Malcolmnixon merged 3 commits intomainfrom
copilot/fix-build-pipeline-comments

Conversation

Copy link
Contributor

Copilot AI commented Feb 19, 2026

Pull Request

Description

The build pipeline was missing several key patterns from the TemplateDotNetTool template: job-level comments, logical step grouping in build-docs, tool version capture (VersionMark), automated build notes generation (BuildMark), and the SpdxTool Build Notes PDF artifact.

Tool Integration

  • Added demaconsulting.versionmark (v0.1.0) and demaconsulting.buildmark (v0.3.0) to .config/dotnet-tools.json
  • Created .versionmark.yaml defining version capture patterns for all build tools

Build Pipeline (build.yaml)

  • Added descriptive comments above each job (quality-checks, build, codeql, build-docs)
  • Added VersionMark capture + artifact upload steps to quality-checks and build (matrix-aware job IDs: build-win/build-ubuntu)
  • Reorganized build-docs into labeled sections matching template structure:
    • === CHECKOUT AND DOWNLOAD ARTIFACTS ===
    • === INSTALL DEPENDENCIES ===
    • === CAPTURE TOOL VERSIONS ===
    • === GENERATE MARKDOWN REPORTS ===
    • === GENERATE HTML DOCUMENTS WITH PANDOC ===
    • === GENERATE PDF DOCUMENTS WITH WEASYPRINT ===
    • === UPLOAD ARTIFACTS ===
  • Added BuildMark step generating docs/buildnotes.md
  • Added VersionMark publish step generating docs/buildnotes/versions.md
  • Added Pandoc → Weasyprint pipeline producing docs/SpdxTool Build Notes.pdf
  • Updated artifact upload to include docs/buildnotes.md

Build Notes Document Infrastructure

  • docs/buildnotes/definition.yaml — Pandoc document definition
  • docs/buildnotes/title.txt — PDF front-matter (title, subtitle, keywords)
  • docs/buildnotes/introduction.md — Static introduction section

Spell Check

  • Added versionmark / VersionMark to .cspell.json

Type of Change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation update
  • Code quality improvement

Related Issues

Pre-Submission Checklist

Before submitting this pull request, ensure you have completed the following:

Build and Test

  • Code builds successfully: dotnet build --configuration Release
  • All tests pass: dotnet test --configuration Release
  • Code produces zero warnings

Code Quality

  • Code formatting is correct: dotnet format --verify-no-changes
  • New code has appropriate XML documentation comments
  • Static analyzer warnings have been addressed

Quality Checks

Please run the following checks before submitting:

  • Spell checker passes: cspell "**/*.{md,cs}"
  • Markdown linter passes: markdownlint "**/*.md"
  • YAML linter passes: yamllint '**/*.{yml,yaml}'

Testing

  • Added unit tests for new functionality
  • Updated existing tests if behavior changed
  • All tests follow the AAA (Arrange, Act, Assert) pattern
  • Test coverage is maintained or improved

Documentation

  • Updated README.md (if applicable)
  • Updated ARCHITECTURE.md (if applicable)
  • Added code examples for new features (if applicable)
  • Updated requirements.yaml (if applicable)

Additional Notes

Pipeline-only changes — no production code modified. The build-docs job now requires VersionMark captures from upstream jobs; continue-on-error: true is set on the version-capture download to prevent failures on first run before those artifacts exist.

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

  • https://api.github.com/repos/demaconsulting/TemplateDotNetTool/contents/docs
    • Triggering command: /usr/bin/curl curl -s REDACTED (http block)
  • https://api.github.com/repos/demaconsulting/TemplateDotNetTool/contents/docs/buildnotes
    • Triggering command: /usr/bin/curl curl -s REDACTED (http block)

If you need me to access, download, or install something from one of these locations, you can either:


💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

Copilot AI and others added 2 commits February 19, 2026 19:00
Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com>
Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com>
Copilot AI changed the title [WIP] Fix build pipeline comments and organization fix: align build pipeline with TemplateDotNetTool patterns Feb 19, 2026
Copilot AI requested a review from Malcolmnixon February 19, 2026 19:05
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