Skip to content

Commit c550cf7

Browse files
CopilotMalcolmnixon
andcommitted
requirements.yaml: rename IDs to SonarMark- prefix with Svr/Rpt/Plt abbreviations
Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com>
1 parent 545e0eb commit c550cf7

File tree

1 file changed

+29
-29
lines changed

1 file changed

+29
-29
lines changed

requirements.yaml

Lines changed: 29 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ sections:
3232
sections:
3333
- title: Command-Line Interface
3434
requirements:
35-
- id: Sonar-Cmd-Cli
35+
- id: SonarMark-Cmd-Cli
3636
title: The tool shall provide a command-line interface.
3737
justification: |
3838
A command-line interface is essential for automation and integration into CI/CD pipelines.
@@ -42,7 +42,7 @@ sections:
4242
- IntegrationTest_VersionFlag_OutputsVersion
4343
- IntegrationTest_HelpFlag_OutputsUsageInformation
4444

45-
- id: Sonar-Cmd-Version
45+
- id: SonarMark-Cmd-Version
4646
title: The tool shall display version information when requested.
4747
justification: |
4848
Version information helps users verify which version of the tool they are running, which is
@@ -51,7 +51,7 @@ sections:
5151
tests:
5252
- IntegrationTest_VersionFlag_OutputsVersion
5353

54-
- id: Sonar-Cmd-Help
54+
- id: SonarMark-Cmd-Help
5555
title: The tool shall display help information when requested.
5656
justification: |
5757
Help information provides users with usage instructions and available options without needing
@@ -60,7 +60,7 @@ sections:
6060
tests:
6161
- IntegrationTest_HelpFlag_OutputsUsageInformation
6262

63-
- id: Sonar-Cmd-Silent
63+
- id: SonarMark-Cmd-Silent
6464
title: The tool shall support silent mode to suppress console output.
6565
justification: |
6666
Silent mode is important for automated environments where console output may interfere with
@@ -69,7 +69,7 @@ sections:
6969
tests:
7070
- IntegrationTest_SilentFlag_SuppressesOutput
7171

72-
- id: Sonar-Cmd-Log
72+
- id: SonarMark-Cmd-Log
7373
title: The tool shall support writing output to a log file.
7474
justification: |
7575
Log file output enables persistent recording of tool execution for later review and audit trails.
@@ -78,7 +78,7 @@ sections:
7878
tests:
7979
- Context_Create_WithLogFile_WritesToLogFile
8080

81-
- id: Sonar-Cmd-Enforce
81+
- id: SonarMark-Cmd-Enforce
8282
title: The tool shall support enforcing quality gate checks.
8383
justification: |
8484
Quality gate enforcement allows the tool to fail builds when quality standards are not met,
@@ -89,7 +89,7 @@ sections:
8989

9090
- title: SonarQube/SonarCloud Integration
9191
requirements:
92-
- id: Sonar-Server-Connect
92+
- id: SonarMark-Svr-Connect
9393
title: The tool shall connect to SonarQube/SonarCloud servers.
9494
justification: |
9595
Connection to SonarQube/SonarCloud servers is the core functionality of the tool, enabling
@@ -99,7 +99,7 @@ sections:
9999
tests:
100100
- IntegrationTest_MissingServerParameter_ShowsError
101101

102-
- id: Sonar-Server-Auth
102+
- id: SonarMark-Svr-Auth
103103
title: The tool shall authenticate with SonarQube/SonarCloud using tokens.
104104
justification: |
105105
Token-based authentication is the secure and recommended method for accessing SonarQube/SonarCloud
@@ -108,7 +108,7 @@ sections:
108108
tests:
109109
- IntegrationTest_TokenParameter_IsAccepted
110110

111-
- id: Sonar-Server-QualityGate
111+
- id: SonarMark-Svr-QualityGate
112112
title: The tool shall fetch quality gate status from SonarQube/SonarCloud.
113113
justification: |
114114
Quality gate status indicates whether code meets the defined quality standards and is fundamental
@@ -117,7 +117,7 @@ sections:
117117
tests:
118118
- SonarMark_QualityGateRetrieval
119119

120-
- id: Sonar-Server-Issues
120+
- id: SonarMark-Svr-Issues
121121
title: The tool shall fetch issues from SonarQube/SonarCloud.
122122
justification: |
123123
Issues represent code quality problems identified by Sonar analysis. Fetching and reporting
@@ -126,7 +126,7 @@ sections:
126126
tests:
127127
- SonarMark_IssuesRetrieval
128128

129-
- id: Sonar-Server-HotSpots
129+
- id: SonarMark-Svr-HotSpots
130130
title: The tool shall fetch security hot-spots from SonarQube/SonarCloud.
131131
justification: |
132132
Security hot-spots highlight code that requires security review, helping teams identify and
@@ -135,7 +135,7 @@ sections:
135135
tests:
136136
- SonarMark_HotSpotsRetrieval
137137

138-
- id: Sonar-Server-ProjectKey
138+
- id: SonarMark-Svr-ProjectKey
139139
title: The tool shall support filtering by project key.
140140
justification: |
141141
Project key filtering is essential for identifying which specific project to analyze when
@@ -144,7 +144,7 @@ sections:
144144
tests:
145145
- IntegrationTest_MissingProjectKeyParameter_ShowsError
146146

147-
- id: Sonar-Server-Branch
147+
- id: SonarMark-Svr-Branch
148148
title: The tool shall support filtering by branch.
149149
justification: |
150150
Branch filtering enables analysis of specific branches in version control, which is crucial
@@ -155,7 +155,7 @@ sections:
155155

156156
- title: Report Generation
157157
requirements:
158-
- id: Sonar-Report-Markdown
158+
- id: SonarMark-Rpt-Markdown
159159
title: The tool shall generate markdown reports.
160160
justification: |
161161
Markdown reports provide human-readable documentation of code quality that can be easily
@@ -166,7 +166,7 @@ sections:
166166
- IntegrationTest_ReportParameter_IsAccepted
167167
- SonarMark_MarkdownReportGeneration
168168

169-
- id: Sonar-Report-Depth
169+
- id: SonarMark-Rpt-Depth
170170
title: The tool shall support configurable report depth.
171171
justification: |
172172
Configurable report depth allows users to control the level of detail in generated reports,
@@ -178,7 +178,7 @@ sections:
178178
- IntegrationTest_ReportDepthWithInvalidValue_ShowsError
179179
- IntegrationTest_ReportDepthWithoutValue_ShowsError
180180

181-
- id: Sonar-Report-QualityGate
181+
- id: SonarMark-Rpt-QualityGate
182182
title: The tool shall include quality gate status in reports.
183183
justification: |
184184
Quality gate status is the most important metric in the report, providing a clear pass/fail
@@ -192,7 +192,7 @@ sections:
192192
- SonarQualityResult_ToMarkdown_WarnStatus_ProducesCorrectOutput
193193
- SonarQualityResult_ToMarkdown_WithFriendlyNames_UsesFriendlyNames
194194

195-
- id: Sonar-Report-Issues
195+
- id: SonarMark-Rpt-Issues
196196
title: The tool shall categorize and report issues by type and severity.
197197
justification: |
198198
Categorizing issues by type and severity helps teams prioritize remediation efforts and
@@ -202,7 +202,7 @@ sections:
202202
- SonarQualityResult_ToMarkdown_WithIssues_ProducesCompilerStyleOutput
203203
- SonarQualityResult_ToMarkdown_WithSingularCounts_ShowsCorrectText
204204

205-
- id: Sonar-Report-HotSpots
205+
- id: SonarMark-Rpt-HotSpots
206206
title: The tool shall report security hot-spots requiring review.
207207
justification: |
208208
Security hot-spots require manual review to determine if they represent actual vulnerabilities.
@@ -213,7 +213,7 @@ sections:
213213

214214
- title: Validation and Testing
215215
requirements:
216-
- id: Sonar-Val-Validate
216+
- id: SonarMark-Val-Validate
217217
title: The tool shall support self-validation mode.
218218
justification: |
219219
Self-validation mode allows the tool to verify its own functionality without requiring
@@ -227,7 +227,7 @@ sections:
227227
- SonarMark_HotSpotsRetrieval
228228
- SonarMark_MarkdownReportGeneration
229229

230-
- id: Sonar-Val-Results
230+
- id: SonarMark-Val-Results
231231
title: The tool shall write validation results to test result files.
232232
justification: |
233233
Writing validation results to test result files allows integration with standard testing
@@ -237,7 +237,7 @@ sections:
237237
- Context_Create_ResultsFile_SetsResultsProperty
238238
- Context_Create_MissingResultsFilename_ThrowsException
239239

240-
- id: Sonar-Val-TrxFormat
240+
- id: SonarMark-Val-TrxFormat
241241
title: The tool shall support TRX format for test results.
242242
justification: |
243243
TRX (Test Results XML) is the native test results format for Microsoft testing tools and
@@ -246,7 +246,7 @@ sections:
246246
tests:
247247
- Context_Create_ResultsFile_SetsResultsProperty
248248

249-
- id: Sonar-Val-JUnitFormat
249+
- id: SonarMark-Val-JUnitFormat
250250
title: The tool shall support JUnit format for test results.
251251
justification: |
252252
JUnit format is a widely-supported standard for test results across many platforms and tools,
@@ -257,7 +257,7 @@ sections:
257257

258258
- title: Quality Enforcement
259259
requirements:
260-
- id: Sonar-Enf-Mode
260+
- id: SonarMark-Enf-Mode
261261
title: The tool shall support enforcement mode to fail on quality gate failures.
262262
justification: |
263263
Enforcement mode is critical for maintaining code quality standards by preventing builds
@@ -266,7 +266,7 @@ sections:
266266
tests:
267267
- Context_Create_EnforceFlag_SetsEnforceProperty
268268

269-
- id: Sonar-Enf-ExitCode
269+
- id: SonarMark-Enf-ExitCode
270270
title: The tool shall return non-zero exit code when quality gate fails in enforcement mode.
271271
justification: |
272272
Returning a non-zero exit code on quality gate failure is the standard mechanism for
@@ -277,7 +277,7 @@ sections:
277277

278278
- title: Platform Support
279279
requirements:
280-
- id: Sonar-Platform-Windows
280+
- id: SonarMark-Plt-Windows
281281
title: The tool shall run on Windows operating systems.
282282
justification: |
283283
Windows is a major development platform, especially for .NET development. Supporting Windows
@@ -294,7 +294,7 @@ sections:
294294
- windows@SonarMark_HotSpotsRetrieval
295295
- windows@SonarMark_MarkdownReportGeneration
296296

297-
- id: Sonar-Platform-Linux
297+
- id: SonarMark-Plt-Linux
298298
title: The tool shall run on Linux operating systems.
299299
justification: |
300300
Linux is the dominant platform for cloud-based CI/CD systems and containerized environments.
@@ -311,7 +311,7 @@ sections:
311311
- ubuntu@SonarMark_HotSpotsRetrieval
312312
- ubuntu@SonarMark_MarkdownReportGeneration
313313

314-
- id: Sonar-Platform-Net8
314+
- id: SonarMark-Plt-Net8
315315
title: The tool shall support .NET 8.0 runtime.
316316
justification: |
317317
.NET 8.0 is a Long-Term Support (LTS) release with support until November 2026. Supporting
@@ -325,7 +325,7 @@ sections:
325325
- dotnet8.x@SonarMark_HotSpotsRetrieval
326326
- dotnet8.x@SonarMark_MarkdownReportGeneration
327327

328-
- id: Sonar-Platform-Net9
328+
- id: SonarMark-Plt-Net9
329329
title: The tool shall support .NET 9.0 runtime.
330330
justification: |
331331
.NET 9.0 is a Standard Term Support (STS) release providing access to the latest features
@@ -339,7 +339,7 @@ sections:
339339
- dotnet9.x@SonarMark_HotSpotsRetrieval
340340
- dotnet9.x@SonarMark_MarkdownReportGeneration
341341

342-
- id: Sonar-Platform-Net10
342+
- id: SonarMark-Plt-Net10
343343
title: The tool shall support .NET 10.0 runtime.
344344
justification: |
345345
.NET 10.0 is the next Long-Term Support (LTS) release scheduled for November 2025. Supporting

0 commit comments

Comments
 (0)