Fix/reclassify fileassert shared package - #60
Merged
Conversation
FileAssert cannot treat its own published package as an OTS item. Per the software-items standard, a package produced by the same program consumed in CI is a Shared Package. Additionally, the self-validation test names FileAssert_Exists and FileAssert_Contains no longer exist; they were renamed to FileAssert_File and FileAssert_Text when validation was refactored into per-assertion-type files. Changes: - Move docs/reqstream/ots/fileassert.yaml to docs/reqstream/shared/ - Rename requirement ID from FileAssert-OTS-FileAssert to FileAssert-Shared-FileAssert with tag [shared] - Replace FileAssert_Exists and FileAssert_Contains with FileAssert_File, FileAssert_Text, FileAssert_Html, and FileAssert_Pdf to cover the assertion types actually used by this project - Move design and verification docs from ots/ to shared/ folders - Add shared.md overview documents for design and verification sections - Update docs/design/ots.md to remove FileAssert and add clarifying note - Update docs/verification/ots.md to remove FileAssert references - Update both definition.yaml files for correct document assembly - Update docs/design/introduction.md to document Shared Package artifacts - Update .reviewmark.yaml review set from FileAssert-OTS-FileAssert to FileAssert-Shared-FileAssert with corrected paths - Update requirements.yaml include path Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
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.
This pull request refactors the documentation and requirements to reclassify FileAssert from an OTS (Off-The-Shelf) item to a Shared Package. It updates the structure and content of design, requirements, verification documents, and review configuration to reflect this new classification. The documentation is reorganized to clearly distinguish between OTS items and shared packages, and all references, evidence, and review paths are updated accordingly.
Reclassification and Documentation Structure Updates:
FileAssert is now documented as a Shared Package instead of an OTS item, with new sections and files (
docs/design/shared.md,docs/design/shared/fileassert.md,docs/verification/shared.md,docs/verification/shared/fileassert.md). All references in requirements, design, and verification documents are updated to reflect this change. [1] [2] [3] [4] [5] [6] [7] [8] [9] [10] [11] [12] [13] [14] [15]The requirements YAML for FileAssert is moved and rewritten to
docs/reqstream/shared/fileassert.yaml, with requirement and test IDs updated to use the "Shared" prefix.The review configuration in
.reviewmark.yamlis updated to point to the new shared package paths and review IDs.Input File and Reference Updates:
Tooling Update:
demaconsulting.fileasserttool in.config/dotnet-tools.jsonis updated from0.4.0to0.5.1.