Skip to content

Update Pandoc PDF template with version metadata support#39

Merged
Malcolmnixon merged 4 commits intomainfrom
copilot/update-pandoc-pdf-template
Jan 27, 2026
Merged

Update Pandoc PDF template with version metadata support#39
Malcolmnixon merged 4 commits intomainfrom
copilot/update-pandoc-pdf-template

Conversation

Copy link
Contributor

Copilot AI commented Jan 27, 2026

Pull Request

Description

Synchronized PDF template with TestResults project and configured build workflow to inject version and date metadata into generated PDFs.

Template Changes:

  • Added version display in title block and page headers (split layout: title left, version right)
  • Changed code block overflow from overflow-x to overflow for bidirectional scrolling
  • Removed decorative header/footer borders for cleaner appearance

Build Workflow Changes:

  • Updated all 4 pandoc invocations (guide, quality, requirements, trace matrix) to pass:
    • --metadata version="${{ inputs.version }}"
    • --metadata date="$(date +'%Y-%m-%d')"

PDFs will now display version information (e.g., "Version 1.2.3") in both title block and page headers, along with the build date.

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

No new tests required - changes are to documentation generation infrastructure. Template changes copied from TestResults project ensure consistency across DemaConsulting repositories.

The implementation uses bash date command directly (matching TestResults project approach), which works on Windows via Git Bash (GitHub Actions default shell).

Original prompt

This section details on the original issue you should resolve

<issue_title>[Feature]: Update Pandoc PDF template</issue_title>
<issue_description>### Problem Statement

The Pandoc PDF template should be updated and new metadata specified

Proposed Solution

Review the https://github.com/demaconsulting/TestResults project and copy the updated /docs/template pandoc template. Then update the build-docs job in build.yaml to pass the version and date metadata arguments to all pandoc invocations.

Alternatives Considered

No response

Usage Examples

Benefits

Improved PDF documentation

Priority

Low - Nice to have

Willingness to Contribute

Yes, I can submit a pull request

Additional Context

No response

Checklist

  • I have searched existing issues to ensure this is not a duplicate
  • I have provided a clear description of the feature
  • I have explained why this feature would be useful</issue_description>

Comments on the Issue (you are @copilot in this section)


💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

Copilot AI and others added 2 commits January 27, 2026 20:14
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] Update Pandoc PDF template with new metadata Update Pandoc PDF template with version metadata support Jan 27, 2026
Copilot AI requested a review from Malcolmnixon January 27, 2026 20:21
Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com>
Copilot AI requested a review from Malcolmnixon January 27, 2026 20:38
@Malcolmnixon Malcolmnixon marked this pull request as ready for review January 27, 2026 20:48
@Malcolmnixon Malcolmnixon merged commit 0f19d9f into main Jan 27, 2026
11 checks passed
@Malcolmnixon Malcolmnixon deleted the copilot/update-pandoc-pdf-template branch January 27, 2026 20:48
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.

[Feature]: Update Pandoc PDF template

2 participants