Sync with TemplateDotNetLibrary: workflow comments, self-validation, artifact naming, OTS requirements, semantic IDs#125
Conversation
…tion, artifact naming, OTS requirements Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com>
Malcolmnixon
left a comment
There was a problem hiding this comment.
Are you sure you merged in all the changes by inspecting the PRs - the requirements are numeric not semantic IDs. What else did you miss?
… fix AGENTS.md encoding and path Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com>
Done in commit a731483. All 30 requirement IDs now follow the I also applied the other missed changes from the template PRs:
|
|
@copilot Somehow when reviewing the pull requests of the template, you forgot to apply the update to ReqStream 1.4.0 required to provide OTS Software requirements evidence - what else did you miss? |
Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com>
Fixed in commit 045c23b — bumped |
requirements.yaml
Outdated
| - title: Platform Requirements | ||
| requirements: | ||
| - id: REQ-PLAT-001 | ||
| - id: SpdxModel-Plt-DotNet8 |
There was a problem hiding this comment.
Let's change this to "SpdxModel-Plt-Net8" - shorter description - same for the other platform requirements.
There was a problem hiding this comment.
Done in f45fbde — renamed to SpdxModel-Plt-Net8, SpdxModel-Plt-Net9, SpdxModel-Plt-Net10, and SpdxModel-Plt-NetStd20.
requirements.yaml
Outdated
| - net10.0@Spdx2JsonSerializer_SerializeDocument_CorrectResults | ||
|
|
||
| - id: REQ-PLAT-004 | ||
| - id: SpdxModel-Plt-NetStandard20 |
There was a problem hiding this comment.
Lets change this to "SpdxMode-Plt-NetStd20"
There was a problem hiding this comment.
Done in f45fbde — renamed to SpdxModel-Plt-NetStd20 (and shortened the other .NET platform IDs in the same commit).
…rd20 → NetStd20 Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com>
Brings SpdxModel in line with recent TemplateDotNetLibrary template updates across six areas: structured workflow section comments, OTS tool self-validation, unified artifact naming, OTS Software requirements, semantic requirement IDs, and tool version updates.
Description
.github/workflows/build.yaml# === SECTION HEADER ===structured comments to all four jobsartifacts/directory; test results, version captures, CodeQL SARIF, and self-validation TRXs all land thereartifacts-quality,artifacts-build-{os},artifacts-codeql,packages-{os}--validate --resultsself-validation steps:quality-checks/build: VersionMarkbuild-docs: ReqStream, BuildMark, VersionMark, SarifMark, SonarMarkbuild-docsartifact download to singlepattern: 'artifacts-*'withmerge-multiple: truetitle.txtpositional args from Pandoc steps (now declared indefinition.yaml)--testsglob toartifacts/**/*.trx; CodeQL output dir toartifacts"artifacts/**/versionmark-*.json".github/workflows/release.yamlartifacts-ubuntu-latest→packages-ubuntu-latest.config/dotnet-tools.jsondemaconsulting.reqstreamfrom1.3.0to1.4.0(required for--validate --resultsOTS self-validation)docs/*/definition.yamltitle.txttoinput-filesin:guide,quality,requirements,justifications,tracematrixdocs/buildnotes/versions.mdtobuildnotes/definition.yamlrequirements.yamlREQ-SER-001) withSpdxModel-{Section}-{Description}semantic IDs (e.g.SpdxModel-Ser-Deserialize22Json,SpdxModel-Plt-Net8)SpdxModel-Plt-Net8,SpdxModel-Plt-Net9,SpdxModel-Plt-Net10,SpdxModel-Plt-NetStd20SpdxModel-OTS-*requirements for MSTest, ReqStream, BuildMark, VersionMark, SarifMark, and SonarMark, each linked to the self-validation test names those tools emitAGENTS.mdUTF-8+BOM→UTF-8(matching the actual.editorconfigcharset = utf-8setting)test-results/**/*.trx→artifacts/**/*.trxType of Change
Pre-Submission Checklist
Before submitting this pull request, ensure you have completed the following:
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
OTS self-validation TRX files are consumed by ReqStream's
--enforcecheck to satisfy the newSpdxModel-OTS-*requirements. The test names (VersionMark_CapturesVersions,ReqStream_EnforcementMode, etc.) must match what each tool emits when run with--validate. ReqStream 1.4.0 is required to support the--validate --resultsflag used in the self-validation steps.💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.