Skip to content

Commit 9182ab1

Browse files
Copilottspascoal
andcommitted
Update README.md to document CI test results reporting features
Co-authored-by: tspascoal <7847935+tspascoal@users.noreply.github.com>
1 parent 33e7c82 commit 9182ab1

File tree

1 file changed

+13
-1
lines changed

1 file changed

+13
-1
lines changed

README.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -223,7 +223,19 @@ For comprehensive guidance, refer to the [official Microsoft documentation on cr
223223

224224
Both GitHub Actions as well as Azure Pipelines are provided to execute continuous integration. (they are triggered by either a pull request or a push against the `main` branch).
225225

226-
The CI Action packages the extension and uploads it as an artifact, the extension is packaged as `ENTER YOUR PUBLISHER HERE` publisher. You should use your own publisher by setting a variable with the name `PUBLISHER` on the CI pipeline.
226+
The CI workflows include the following features:
227+
228+
- **Build and Test**: Compile TypeScript, run unit tests, and package the extension
229+
- **Unit Test Results**: Both CI systems are configured to publish unit test results:
230+
- **GitHub Actions**: Uses `dorny/test-reporter` to publish test results as pull request comments with detailed test summaries
231+
- **Azure Pipelines**: Uses `PublishTestResults@2` task to display test results in the pipeline run with integrated reporting
232+
- **Test Reporting Configuration**: Jest is configured with JUnit XML reporting (`jest-junit`) to generate standardized test result files that both CI systems can consume
233+
- **Artifact Publishing**: The extension is packaged and uploaded as an artifact
234+
235+
The extension is packaged as `ENTER YOUR PUBLISHER HERE` publisher. You should use your own publisher by setting a variable with the name `PUBLISHER` on the CI pipeline.
236+
237+
> [!NOTE]
238+
> Test results are published even if tests fail, providing visibility into test outcomes for both successful and failing builds.
227239

228240
## Contributing
229241

0 commit comments

Comments
 (0)