Skip to content
Snippets Groups Projects
Commit ad3456d1 authored by Xiao Pan's avatar Xiao Pan
Browse files

doc: update README

parent 704f3a51
No related branches found
No related tags found
No related merge requests found
......@@ -56,6 +56,32 @@ The `style_and_lint_checks` step in the [CI job](utils/ci/Jenkinsfile) ensures c
./utils/ci/scripts/check_and_fix/check_and_fix.sh
```
### Code-coverage
The code-coverage report can be accessed at the following link: [code-coverage report](https://ci.eclipse.org/openpass/job/GtGenCore/job/main/lastSuccessfulBuild/artifact/artifacts/_site/bazel-coverage/index.html). This report is automatically updated after each commit is merged into the `main` branch and is also included in the artifacts for each tagged release.
To generate the code-coverage report locally, you can find the report under `bazel-coverage/index.html` by following the instructions below:
#### Use script locally:
- For native Linux systems:
```bash
./utils/ci/scripts/build_and_test/code_coverage.sh
```
### Tests Report
Access the detailed Tests report at the following link: [test report](https://ci.eclipse.org/openpass/job/GtGenCore/job/main/lastSuccessfulBuild/artifact/artifacts/_site/test_results.html). This report summarises the outcomes of unit tests, including counts of passed, failed, disabled, and errored tests, alongside total execution time. This report is automatically updated after each commit is merged into the `main` branch and is also included in the artifacts for each tagged release.
#### Use script locally:
To generate the test locally, you can find the report under `test_results.html` by following the instructions below:
- For native Linux systems:
```bash
./utils/ci/scripts/build_and_test/generate_test_report.sh
```
### Versioning
Versioning should follow the [Semantic Versioning](https://semver.org/) pattern MAJOR.MINOR.PATCH.
Currently this is a manual task that needs to be approved as a part of a code review.
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment