Skip to content

Standardize build-docs shell to bash for SarifMark consistency#72

Merged
Malcolmnixon merged 4 commits intomainfrom
copilot/improve-build-consistency
Jan 28, 2026
Merged

Standardize build-docs shell to bash for SarifMark consistency#72
Malcolmnixon merged 4 commits intomainfrom
copilot/improve-build-consistency

Conversation

Copy link
Contributor

Copilot AI commented Jan 28, 2026

Pull Request

Description

Aligns build-docs job with SarifMark's workflow patterns. All shell-dependent steps now use bash explicitly instead of mixed PowerShell, ensuring consistent cross-platform behavior and maintainability between sister projects.

Changes:

  • Shell specifications: pwshbash for install, generate, and display steps
  • Command syntax: PowerShell backticks → bash backslashes, $env:SONAR_TOKEN$SONAR_TOKEN
  • Report display: Get-Contentcat
  • Tool invocation: Correctly uses dotnet sarifmark (local tool via dotnet-tools.json) and sonarmark (globally installed)

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

N/A

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

Workflow-only change. No code or test modifications required. YAML validated with yamllint. CodeQL security scan passed.

Original prompt

Please review the build.yaml from https://github.com/demaconsulting/SarifMark and make this projects build more consistent - especially around the build-docs with regards to shell specifications and how the reports are printed.


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

Copilot AI and others added 2 commits January 28, 2026 13:08
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] Improve project build consistency and report printing Standardize build-docs shell to bash for SarifMark consistency Jan 28, 2026
Copilot AI requested a review from Malcolmnixon January 28, 2026 13:11
--report-depth 1
shell: bash
run: >
sarifmark
Copy link
Contributor

Choose a reason for hiding this comment

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

The sarifmark tool still needs to be run using 'dotnet sarifmark' as it's installed locally via the dotnet-tools.json file in this project. This isn't needed for the 'sonarmark' tool later as that one is installed globally in this project.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Fixed in 7ee3bfd. Changed to dotnet sarifmark since it's installed locally via dotnet-tools.json, while sonarmark remains directly callable as it's installed globally.

Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@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