diff --git a/.reviewmark.yaml b/.reviewmark.yaml index 55b492d..d9218a4 100644 --- a/.reviewmark.yaml +++ b/.reviewmark.yaml @@ -24,7 +24,7 @@ reviews: - id: VersionMark-System title: VersionMark System Review paths: - - "docs/reqstream/versionmark-system.yaml" # system requirements + - "docs/reqstream/system.yaml" # system requirements - "docs/reqstream/platform-requirements.yaml" # platform requirements - "docs/design/introduction.md" # design introduction and architecture - "docs/design/system.md" # system design @@ -35,7 +35,7 @@ reviews: - id: VersionMark-Design title: VersionMark Design Document Review paths: - - "docs/reqstream/versionmark-system.yaml" # system requirements + - "docs/reqstream/system.yaml" # system requirements - "docs/reqstream/platform-requirements.yaml" # platform requirements - "docs/design/**/*.md" # all design documents @@ -49,7 +49,7 @@ reviews: - id: VersionMark-Cli-Subsystem title: Review of Cli Subsystem paths: - - "docs/reqstream/cli/subsystem-cli.yaml" # subsystem requirements + - "docs/reqstream/cli/cli.yaml" # subsystem requirements - "docs/design/cli/cli.md" # subsystem design - "docs/design/cli/program.md" # Program unit design - "docs/design/cli/context.md" # Context unit design @@ -58,7 +58,7 @@ reviews: - id: VersionMark-Program-Review title: Review of Program Unit paths: - - "docs/reqstream/cli/unit-program.yaml" # requirements + - "docs/reqstream/cli/program.yaml" # requirements - "docs/design/cli/program.md" # design - "src/**/Program.cs" # implementation - "test/**/ProgramTests.cs" # unit tests @@ -66,7 +66,7 @@ reviews: - id: VersionMark-Context-Review title: Review of Context Unit paths: - - "docs/reqstream/cli/unit-context.yaml" # requirements + - "docs/reqstream/cli/context.yaml" # requirements - "docs/design/cli/context.md" # design - "src/**/Cli/Context.cs" # implementation - "test/**/Cli/ContextTests.cs" # unit tests @@ -75,100 +75,100 @@ reviews: - id: VersionMark-Configuration-Subsystem title: Review of Configuration Subsystem paths: - - "docs/reqstream/configuration/subsystem-configuration.yaml" # subsystem requirements - - "docs/design/configuration/configuration.md" # subsystem design - - "docs/design/configuration/version-mark-config.md" # VersionMarkConfig unit design - - "docs/design/configuration/tool-config.md" # ToolConfig unit design - - "test/**/Configuration/ConfigurationSubsystemTests.cs" # subsystem tests + - "docs/reqstream/configuration/configuration.yaml" # subsystem requirements + - "docs/design/configuration/configuration.md" # subsystem design + - "docs/design/configuration/version-mark-config.md" # VersionMarkConfig unit design + - "docs/design/configuration/tool-config.md" # ToolConfig unit design + - "test/**/Configuration/ConfigurationSubsystemTests.cs" # subsystem tests - id: VersionMark-VersionMarkConfig-Review title: Review of VersionMarkConfig Unit paths: - - "docs/reqstream/configuration/unit-version-mark-config.yaml" # requirements - - "docs/design/configuration/version-mark-config.md" # design - - "src/**/Configuration/VersionMarkConfig.cs" # implementation - - "test/**/Configuration/VersionMarkConfigTests.cs" # unit tests + - "docs/reqstream/configuration/version-mark-config.yaml" # requirements + - "docs/design/configuration/version-mark-config.md" # design + - "src/**/Configuration/VersionMarkConfig.cs" # implementation + - "test/**/Configuration/VersionMarkConfigTests.cs" # unit tests - id: VersionMark-ToolConfig-Review title: Review of ToolConfig Unit paths: - - "docs/reqstream/configuration/unit-tool-config.yaml" # requirements - - "docs/design/configuration/tool-config.md" # design - - "src/**/Configuration/VersionMarkConfig.cs" # implementation - - "test/**/Configuration/VersionMarkConfigTests.cs" # unit tests + - "docs/reqstream/configuration/tool-config.yaml" # requirements + - "docs/design/configuration/tool-config.md" # design + - "src/**/Configuration/VersionMarkConfig.cs" # implementation + - "test/**/Configuration/VersionMarkConfigTests.cs" # unit tests # Capture Subsystem - id: VersionMark-Capture-Subsystem title: Review of Capture Subsystem paths: - - "docs/reqstream/capture/subsystem-capture.yaml" # subsystem requirements - - "docs/design/capture/capture.md" # subsystem design - - "docs/design/capture/version-info.md" # VersionInfo unit design - - "test/**/Capture/CaptureSubsystemTests.cs" # subsystem tests + - "docs/reqstream/capture/capture.yaml" # subsystem requirements + - "docs/design/capture/capture.md" # subsystem design + - "docs/design/capture/version-info.md" # VersionInfo unit design + - "test/**/Capture/CaptureSubsystemTests.cs" # subsystem tests - id: VersionMark-VersionInfo-Review title: Review of VersionInfo Unit paths: - - "docs/reqstream/capture/unit-version-info.yaml" # requirements - - "docs/design/capture/version-info.md" # design - - "src/**/Capture/VersionInfo.cs" # implementation - - "test/**/Capture/VersionInfoTests.cs" # unit tests + - "docs/reqstream/capture/version-info.yaml" # requirements + - "docs/design/capture/version-info.md" # design + - "src/**/Capture/VersionInfo.cs" # implementation + - "test/**/Capture/VersionInfoTests.cs" # unit tests # Publishing Subsystem - id: VersionMark-Publishing-Subsystem title: Review of Publishing Subsystem paths: - - "docs/reqstream/publishing/subsystem-publishing.yaml" # subsystem requirements - - "docs/design/publishing/publishing.md" # subsystem design - - "docs/design/publishing/markdown-formatter.md" # MarkdownFormatter unit design - - "test/**/Publishing/PublishingSubsystemTests.cs" # subsystem tests + - "docs/reqstream/publishing/publishing.yaml" # subsystem requirements + - "docs/design/publishing/publishing.md" # subsystem design + - "docs/design/publishing/markdown-formatter.md" # MarkdownFormatter unit design + - "test/**/Publishing/PublishingSubsystemTests.cs" # subsystem tests - id: VersionMark-MarkdownFormatter-Review title: Review of MarkdownFormatter Unit paths: - - "docs/reqstream/publishing/unit-formatter.yaml" # requirements - - "docs/design/publishing/markdown-formatter.md" # design - - "src/**/Publishing/MarkdownFormatter.cs" # implementation - - "test/**/Publishing/MarkdownFormatterTests.cs" # unit tests + - "docs/reqstream/publishing/markdown-formatter.yaml" # requirements + - "docs/design/publishing/markdown-formatter.md" # design + - "src/**/Publishing/MarkdownFormatter.cs" # implementation + - "test/**/Publishing/MarkdownFormatterTests.cs" # unit tests # Linting Subsystem - id: VersionMark-Linting-Subsystem title: Review of Linting Subsystem paths: - - "docs/reqstream/linting/subsystem-linting.yaml" # subsystem requirements - - "docs/design/linting/linting.md" # subsystem design - - "docs/design/linting/lint.md" # Lint unit design - - "test/**/Linting/LintingSubsystemTests.cs" # subsystem tests + - "docs/reqstream/linting/linting.yaml" # subsystem requirements + - "docs/design/linting/linting.md" # subsystem design + - "docs/design/linting/lint.md" # Lint unit design + - "test/**/Linting/LintingSubsystemTests.cs" # subsystem tests - id: VersionMark-Lint-Review title: Review of Lint Unit paths: - - "docs/reqstream/linting/unit-lint.yaml" # requirements - - "docs/design/linting/lint.md" # design - - "src/**/Linting/Lint.cs" # implementation - - "test/**/Linting/LintTests.cs" # unit tests + - "docs/reqstream/linting/lint.yaml" # requirements + - "docs/design/linting/lint.md" # design + - "src/**/Linting/Lint.cs" # implementation + - "test/**/Linting/LintTests.cs" # unit tests # SelfTest Subsystem - id: VersionMark-SelfTest-Subsystem title: Review of SelfTest Subsystem paths: - - "docs/reqstream/self-test/subsystem-selftest.yaml" # subsystem requirements - - "docs/design/self-test/self-test.md" # subsystem design - - "docs/design/self-test/validation.md" # Validation unit design - - "docs/design/self-test/path-helpers.md" # PathHelpers unit design - - "test/**/SelfTest/SelfTestSubsystemTests.cs" # subsystem tests + - "docs/reqstream/self-test/self-test.yaml" # subsystem requirements + - "docs/design/self-test/self-test.md" # subsystem design + - "docs/design/self-test/validation.md" # Validation unit design + - "docs/design/self-test/path-helpers.md" # PathHelpers unit design + - "test/**/SelfTest/SelfTestSubsystemTests.cs" # subsystem tests - id: VersionMark-Validation-Review title: Review of Validation Unit paths: - - "docs/reqstream/self-test/unit-validation.yaml" # requirements - - "docs/design/self-test/validation.md" # design - - "src/**/SelfTest/Validation.cs" # implementation + - "docs/reqstream/self-test/validation.yaml" # requirements + - "docs/design/self-test/validation.md" # design + - "src/**/SelfTest/Validation.cs" # implementation - id: VersionMark-PathHelpers-Review title: Review of PathHelpers Unit paths: - - "docs/reqstream/self-test/unit-path-helpers.yaml" # requirements - - "docs/design/self-test/path-helpers.md" # design - - "src/**/SelfTest/PathHelpers.cs" # implementation - - "test/**/SelfTest/PathHelpersTests.cs" # unit tests + - "docs/reqstream/self-test/path-helpers.yaml" # requirements + - "docs/design/self-test/path-helpers.md" # design + - "src/**/SelfTest/PathHelpers.cs" # implementation + - "test/**/SelfTest/PathHelpersTests.cs" # unit tests diff --git a/docs/design/system.md b/docs/design/system.md index 33481ac..2ee852a 100644 --- a/docs/design/system.md +++ b/docs/design/system.md @@ -101,7 +101,7 @@ that the tool is functioning correctly after installation: | `VersionMark_LintPassesForValidConfig` | Lint mode passes for a valid `.versionmark.yaml` configuration | | `VersionMark_LintReportsErrorsForInvalidConfig` | Lint mode reports errors for an invalid configuration | -These test names appear in requirements files (e.g., `versionmark-system.yaml`, +These test names appear in requirements files (e.g., `system.yaml`, `platform-requirements.yaml`) as traceability evidence. When `--validate` is run in CI, each matrix job runs on a specific platform/runtime and produces a TRX results file whose filename and CI job context (e.g., `artifacts/validation-windows-latest-dotnet8.x.trx`) diff --git a/docs/reqstream/capture/subsystem-capture.yaml b/docs/reqstream/capture/capture.yaml similarity index 100% rename from docs/reqstream/capture/subsystem-capture.yaml rename to docs/reqstream/capture/capture.yaml diff --git a/docs/reqstream/capture/unit-version-info.yaml b/docs/reqstream/capture/version-info.yaml similarity index 100% rename from docs/reqstream/capture/unit-version-info.yaml rename to docs/reqstream/capture/version-info.yaml diff --git a/docs/reqstream/cli/subsystem-cli.yaml b/docs/reqstream/cli/cli.yaml similarity index 100% rename from docs/reqstream/cli/subsystem-cli.yaml rename to docs/reqstream/cli/cli.yaml diff --git a/docs/reqstream/cli/unit-context.yaml b/docs/reqstream/cli/context.yaml similarity index 100% rename from docs/reqstream/cli/unit-context.yaml rename to docs/reqstream/cli/context.yaml diff --git a/docs/reqstream/cli/unit-program.yaml b/docs/reqstream/cli/program.yaml similarity index 100% rename from docs/reqstream/cli/unit-program.yaml rename to docs/reqstream/cli/program.yaml diff --git a/docs/reqstream/configuration/subsystem-configuration.yaml b/docs/reqstream/configuration/configuration.yaml similarity index 100% rename from docs/reqstream/configuration/subsystem-configuration.yaml rename to docs/reqstream/configuration/configuration.yaml diff --git a/docs/reqstream/configuration/unit-tool-config.yaml b/docs/reqstream/configuration/tool-config.yaml similarity index 100% rename from docs/reqstream/configuration/unit-tool-config.yaml rename to docs/reqstream/configuration/tool-config.yaml diff --git a/docs/reqstream/configuration/unit-version-mark-config.yaml b/docs/reqstream/configuration/version-mark-config.yaml similarity index 100% rename from docs/reqstream/configuration/unit-version-mark-config.yaml rename to docs/reqstream/configuration/version-mark-config.yaml diff --git a/docs/reqstream/linting/unit-lint.yaml b/docs/reqstream/linting/lint.yaml similarity index 100% rename from docs/reqstream/linting/unit-lint.yaml rename to docs/reqstream/linting/lint.yaml diff --git a/docs/reqstream/linting/subsystem-linting.yaml b/docs/reqstream/linting/linting.yaml similarity index 100% rename from docs/reqstream/linting/subsystem-linting.yaml rename to docs/reqstream/linting/linting.yaml diff --git a/docs/reqstream/ots-buildmark.yaml b/docs/reqstream/ots/buildmark.yaml similarity index 100% rename from docs/reqstream/ots-buildmark.yaml rename to docs/reqstream/ots/buildmark.yaml diff --git a/docs/reqstream/ots-mstest.yaml b/docs/reqstream/ots/mstest.yaml similarity index 100% rename from docs/reqstream/ots-mstest.yaml rename to docs/reqstream/ots/mstest.yaml diff --git a/docs/reqstream/ots-reqstream.yaml b/docs/reqstream/ots/reqstream.yaml similarity index 100% rename from docs/reqstream/ots-reqstream.yaml rename to docs/reqstream/ots/reqstream.yaml diff --git a/docs/reqstream/ots-reviewmark.yaml b/docs/reqstream/ots/reviewmark.yaml similarity index 100% rename from docs/reqstream/ots-reviewmark.yaml rename to docs/reqstream/ots/reviewmark.yaml diff --git a/docs/reqstream/ots-sarifmark.yaml b/docs/reqstream/ots/sarifmark.yaml similarity index 100% rename from docs/reqstream/ots-sarifmark.yaml rename to docs/reqstream/ots/sarifmark.yaml diff --git a/docs/reqstream/ots-sonarmark.yaml b/docs/reqstream/ots/sonarmark.yaml similarity index 100% rename from docs/reqstream/ots-sonarmark.yaml rename to docs/reqstream/ots/sonarmark.yaml diff --git a/docs/reqstream/publishing/unit-formatter.yaml b/docs/reqstream/publishing/markdown-formatter.yaml similarity index 100% rename from docs/reqstream/publishing/unit-formatter.yaml rename to docs/reqstream/publishing/markdown-formatter.yaml diff --git a/docs/reqstream/publishing/subsystem-publishing.yaml b/docs/reqstream/publishing/publishing.yaml similarity index 100% rename from docs/reqstream/publishing/subsystem-publishing.yaml rename to docs/reqstream/publishing/publishing.yaml diff --git a/docs/reqstream/self-test/unit-path-helpers.yaml b/docs/reqstream/self-test/path-helpers.yaml similarity index 100% rename from docs/reqstream/self-test/unit-path-helpers.yaml rename to docs/reqstream/self-test/path-helpers.yaml diff --git a/docs/reqstream/self-test/subsystem-selftest.yaml b/docs/reqstream/self-test/self-test.yaml similarity index 100% rename from docs/reqstream/self-test/subsystem-selftest.yaml rename to docs/reqstream/self-test/self-test.yaml diff --git a/docs/reqstream/self-test/unit-validation.yaml b/docs/reqstream/self-test/validation.yaml similarity index 100% rename from docs/reqstream/self-test/unit-validation.yaml rename to docs/reqstream/self-test/validation.yaml diff --git a/docs/reqstream/versionmark-system.yaml b/docs/reqstream/system.yaml similarity index 100% rename from docs/reqstream/versionmark-system.yaml rename to docs/reqstream/system.yaml diff --git a/requirements.yaml b/requirements.yaml index 68a3b15..16403f6 100644 --- a/requirements.yaml +++ b/requirements.yaml @@ -5,26 +5,26 @@ # Requirements are verified through tests and documented in docs/requirements_doc/ and docs/requirements_report/. includes: - - docs/reqstream/versionmark-system.yaml + - docs/reqstream/system.yaml - docs/reqstream/platform-requirements.yaml - - docs/reqstream/cli/subsystem-cli.yaml - - docs/reqstream/cli/unit-program.yaml - - docs/reqstream/cli/unit-context.yaml - - docs/reqstream/capture/subsystem-capture.yaml - - docs/reqstream/capture/unit-version-info.yaml - - docs/reqstream/publishing/subsystem-publishing.yaml - - docs/reqstream/publishing/unit-formatter.yaml - - docs/reqstream/configuration/subsystem-configuration.yaml - - docs/reqstream/configuration/unit-version-mark-config.yaml - - docs/reqstream/configuration/unit-tool-config.yaml - - docs/reqstream/linting/subsystem-linting.yaml - - docs/reqstream/linting/unit-lint.yaml - - docs/reqstream/self-test/subsystem-selftest.yaml - - docs/reqstream/self-test/unit-validation.yaml - - docs/reqstream/self-test/unit-path-helpers.yaml - - docs/reqstream/ots-mstest.yaml - - docs/reqstream/ots-reqstream.yaml - - docs/reqstream/ots-buildmark.yaml - - docs/reqstream/ots-sarifmark.yaml - - docs/reqstream/ots-sonarmark.yaml - - docs/reqstream/ots-reviewmark.yaml + - docs/reqstream/cli/cli.yaml + - docs/reqstream/cli/program.yaml + - docs/reqstream/cli/context.yaml + - docs/reqstream/capture/capture.yaml + - docs/reqstream/capture/version-info.yaml + - docs/reqstream/publishing/publishing.yaml + - docs/reqstream/publishing/markdown-formatter.yaml + - docs/reqstream/configuration/configuration.yaml + - docs/reqstream/configuration/version-mark-config.yaml + - docs/reqstream/configuration/tool-config.yaml + - docs/reqstream/linting/linting.yaml + - docs/reqstream/linting/lint.yaml + - docs/reqstream/self-test/self-test.yaml + - docs/reqstream/self-test/validation.yaml + - docs/reqstream/self-test/path-helpers.yaml + - docs/reqstream/ots/mstest.yaml + - docs/reqstream/ots/reqstream.yaml + - docs/reqstream/ots/buildmark.yaml + - docs/reqstream/ots/sarifmark.yaml + - docs/reqstream/ots/sonarmark.yaml + - docs/reqstream/ots/reviewmark.yaml