Skip to content

Commit 8a2cb9f

Browse files
committed
Doc update
1 parent b27df8c commit 8a2cb9f

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -236,7 +236,7 @@ It shows coverage trends and allows drilling down to more detailed coverage info
236236
- Trend charts of the coverage over time
237237

238238
:warning: Legacy Plugin Info
239-
This is a legacy plugin and will have no futher development beyond bug fixes and security updates
239+
This is a legacy plugin and will have no further development beyond bug fixes and security updates
240240

241241
<img src="docs/images/vcc_cov_report.png" width="700" />
242242

@@ -266,18 +266,18 @@ Use Coverage History marks build as failed if statement or branch coverage decre
266266
Use Strict Test Case Importing allows the job to mark individual test cases as failures if errors encountered during test script import. This option enables strict testcase importing for the VectorCAST Project. This option give a more reliable metrics for pass/fail test cases as without strict test case import, bad test cases are just ignored. The default is enabled.
267267

268268
#### Use Requirements Gateway 3 capabilities
269-
This option allows test environments with existing tests linked to an Requirements Gateway v3 implementation, that uses seperate .json files, to execute in parallel and export data at the end of the run.
269+
This option allows test environments with existing tests linked to a Requirements Gateway v3 implementation, that uses separate .json files, to execute in parallel and export data at the end of the run.
270270

271271
#### Use Imported Results
272-
Use Imported Results allows jobs to previous test results as input for the current job execution phase. This option allows VectorCAST Change Based Testing to have a known result to work from. This option works in conjunction with _Use Change Based Testing_. The user can selected between internal imported results or external result files
272+
Use Imported Results allows jobs to previous test results as input for the current job execution phase. This option allows VectorCAST Change Based Testing to have a known result to work from. This option works in conjunction with _Use Change Based Testing_. The user can select between internal imported results or external result files
273273

274274
<img src="docs/images/use_imported_results.png" width="345" height="151" />
275275

276276
#### Using Local Imported Results
277-
When using imported results and the Use Local Imported Results option, the job will export results from the current build and save that result file as an job artifact. The next build will pull the result archive from the last SUCCESS or UNSTABLE build and use change based testing against that result baseline. If existing build artifacts exist, the combined results will be used for change based testing.
277+
When using imported results and the Use Local Imported Results option, the job will export results from the current build and save that result file as a job artifact. The next build will pull the result archive from the last SUCCESS or UNSTABLE build and use change based testing against that result baseline. If existing build artifacts exist, the combined results will be used for change based testing.
278278

279279
#### Using External Imported Results
280-
When using imported results and the Use External Result File option, the job will use an external results from the a specified location to use as a baseline for the the current job. If existing build artifacts exist, the combined results will be used for change based testing. The user will need to specify an external result filename (.vcr) in the External Result Filename option. This file would be typically stored in the repository. This external result file could be updated by a main branch or periodic build to establish a current baseline.
280+
When using imported results and the Use External Result File option, the job will use an external result from a specified location to use as a baseline for the current job. If existing build artifacts exist, the combined results will be used for change based testing. The user will need to specify an external result filename (.vcr) in the External Result Filename option. This file would be typically stored in the repository. This external result file could be updated by a main branch or periodic build to establish a current baseline.
281281

282282
### Additional Tools
283283

@@ -301,7 +301,7 @@ For [Squore](https://www.vector.com/int/en/products/products-a-z/software/squore
301301

302302
#### TESTinsights
303303
For [TESTinsights](https://www.vector.com/int/en/products/products-a-z/software/vectorcast/vectorcast-testinsights), if the user is using Git or Subversion for SCM, the plugin will attempt to have the SCM version linked to the TESTinsights project for team access and distributed change based testing. The user must provide the following:
304-
- TESTinsights URL - The URL to TESTinsights server and project (Use Copy Team Area Url).
304+
- TESTinsights URL - The URL to TESTinsights server and project (Use Copy Team Area URL).
305305
- TESTinsights Project - The Project Name in TESTinsights to push the results (leave blank to use the Jenkins Job Name).
306306
- TESTinsights Credential ID - The Credential ID from Jenkins for TESTinsights.
307307
- The proxy to push to TESTinsights server in the format **proxy.address:port** (optional)
@@ -372,7 +372,7 @@ For non-pipeline jobs, JUnit publisher will fail any environments published with
372372

373373
### Potential loss of requirements information
374374

375-
For customers using VectorCAST's requirements gateway, there's a potential for loss of requirements data when running test environments in parallel while using a shared requriments database.
375+
For customers using VectorCAST's requirements gateway, there's a potential for loss of requirements data when running test environments in parallel while using a shared requirements database.
376376

377377
### Test and code coverage reporting with Imported Results
378378

@@ -385,15 +385,15 @@ VectorCAST/QA projects cannot use imported results for change based testing
385385
### Disabled environments may add coverage metrics
386386

387387
In rare cases, VectorCAST projects will have disabled environment with results stored before they were disabled. In cases where the disabled environments share source file with enabled environments, this may lead addition coverage metrics. It is recommended to clean the
388-
environment before disabling. This takes into account enviornments that are directly disabled or disabled at the Compiler or TestSuite Nodes. To avoid this, please clean environments before disabling them
388+
environment before disabling. This takes into account environments that are directly disabled or disabled at the Compiler or TestSuite Nodes. To avoid this, please clean environments before disabling them
389389

390390
## Change Log
391391

392392
### Version 0.79 (4 May 2025)
393393
- Moved to minimum Jenkins Version 2.492.3 and Java 21
394394
- Update pom.xml to get a build of the plugin and to Java21
395-
- Update NewSingleJob to catch new execption thrown from SecureGroovyScript
396-
- Update jenkinsfile pipeline script to match up with the latest groovy intepreter
395+
- Update NewSingleJob to catch new exception thrown from SecureGroovyScript
396+
- Update jenkinsfile pipeline script to match up with the latest groovy interpreter
397397
- Missing def before globals
398398
- Pipeline can access VC_ global vars, but not functions
399399
- Need to pass all required VC_ global vars to functions

0 commit comments

Comments
 (0)