Sync with TemplateDotNetLibrary: workflow section comments, self-validation, artifact naming, OTS requirements, and semantic requirement IDs#112
Merged
Malcolmnixon merged 3 commits intomainfrom Mar 4, 2026
Conversation
…rtifact naming, OTS requirements Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Update template project with recent changes and best practices
Sync with TemplateDotNetLibrary: workflow section comments, self-validation, artifact naming, OTS requirements
Mar 4, 2026
Contributor
|
@copilot You seem to have skipped numerous updates - you didn't update ReqStream to 1.4.0 required to provide OTS Software evidence - you didn't convert the requirement IDs from numeric-IDs to semantic-IDs. Please follow the repo-consistency agent instructions for going through the pull requests and apply ALL the appropriate changes. |
… with 3-char sections Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com>
Contributor
Author
Done in commit
|
Copilot
AI
changed the title
Sync with TemplateDotNetLibrary: workflow section comments, self-validation, artifact naming, OTS requirements
Sync with TemplateDotNetLibrary: workflow section comments, self-validation, artifact naming, OTS requirements, and semantic requirement IDs
Mar 4, 2026
Malcolmnixon
approved these changes
Mar 4, 2026
This was referenced Mar 16, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Pull Request
Description
Brings the repository in line with recent TemplateDotNetLibrary template updates across five areas: workflow structure comments, OTS tool self-validation steps, unified artifact naming, OTS Software requirements traceability, and semantic requirement IDs.
Workflow Section Comments
Added
# === SECTION ===comment blocks with downstream-project guidance notes to all jobs that were missing them (quality-checks,build,codeql).Artifact Naming Convention
All job outputs now flow through a single
artifacts/directory per job, uploaded as a single artifact, and downloaded inbuild-docswith one step usingpattern: 'artifacts-*'/merge-multiple: true:quality-checksversion-capture-qualityartifacts-qualitybuildversion-capture-{os}+test-results-{os}+artifacts-{os}artifacts-build-{os}+packages-{os}codeqlcodeql-sarif(fromsarif-results/)artifacts-codeql(fromartifacts/)build-docsdownloadartifacts/releasedownloadartifacts-ubuntu-latestpackages-ubuntu-latestDownstream path references updated accordingly (
--tests,--sarif,--publishglobs).OTS Self-Validation Steps
quality-checksandbuild: addedRun VersionMark self-validation(writes TRX toartifacts/)build-docs: added# === CAPTURE OTS SELF-VALIDATION RESULTS ===section with self-validation steps for ReqStream, BuildMark, VersionMark, SarifMark, and SonarMarkRestore Dependencies) inbuildjob; all write output toartifacts/via--outputOTS Software Requirements
Added
OTS Softwaresection torequirements.yamlwith six[ots]-tagged requirements — one per tool (MSTest, ReqStream, BuildMark, VersionMark, SarifMark, SonarMark) — linked to the TRX test names emitted by each tool's--validatemode. This closes the traceability chain: self-validation steps produce TRX evidence → requirements reference those test names →reqstream --enforceproves all OTS tools are functioning.ReqStream 1.4.0
Updated
demaconsulting.reqstreamfrom1.3.0to1.4.0in.config/dotnet-tools.json. Version 1.4.0 is required to support OTS Software evidence collection.Semantic Requirement IDs
Converted all 28 requirement IDs from numeric (
REQ-FUNC-xxx,REQ-OTS-xxx) to semantic with 3-character section abbreviations following theTestResults-{Sec}-{Description}pattern:MdlTestResults-Mdl-PassedOutcomeSerTestResults-Ser-FormatIdentifyTrxTestResults-Trx-SerializeJunTestResults-Jun-DeserializeRunTestResults-Run-Net8OTSTestResults-OTS-ReqStreamType of Change
Related Issues
Pre-Submission Checklist
Build and Test
dotnet build --configuration Releasedotnet test --configuration ReleaseCode Quality
dotnet format --verify-no-changesQuality Checks
Please run the following checks before submitting:
cspell "**/*.{md,cs}"markdownlint "**/*.md"yamllint .Testing
Documentation
Additional Notes
All requirement ID changes are non-breaking within the traceability system — the IDs are internal identifiers used only within
requirements.yamland the generated trace matrix documents.🔒 GitHub Advanced Security automatically protects Copilot coding agent pull requests. You can protect all pull requests by enabling Advanced Security for your repositories. Learn more about Advanced Security.