Skip to content

Commit

Permalink
Update readme with links to the test results and fixing img path
Browse files Browse the repository at this point in the history
  • Loading branch information
angelrti authored Jun 13, 2024
1 parent a5cb5df commit a85376e
Showing 1 changed file with 27 additions and 23 deletions.
50 changes: 27 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,10 @@ QoS settings. The goal is to validate that the implementations perform
these functions in compliance with OMG DDS-RTPS standard
and can interoperate with each other.

**Find the latest test report here**: https://omg-dds.github.io/dds-rtps/

**Find the latest test result summary here**: https://omg-dds.github.io/dds-rtps/test_results.html

## Table of contents

* 1\. [Introduction](#introduction)
Expand Down Expand Up @@ -449,34 +453,34 @@ The GitHub Actions process must be launched in the following cases:
To generate the report you should follow the next steps:
1. Go to *Actions*.

![Actions](./doc/resource/_md/img/img1.png)
![Actions](./resource/_md/img/img1.png)

2. Go to *Testing Interoperability*.

![Testing-Interoperability](./doc/resource/_md/img/img2.png)
![Testing-Interoperability](./resource/_md/img/img2.png)

3. Press *Run workflow*, select master branch (for the official tests).

![Run-workflow](./doc/resource/_md/img/img3.png)
![Run-workflow](./resource/_md/img/img3.png)

4. Wait a few minutes until the new task is finished and then press it.\
Example of a successful and a failed test:

![Succeeded test](./doc/resource/_md/img/img4.png)
![Failed test](./doc/resource/_md/img/img5.png)
![Succeeded test](./resource/_md/img/img4.png)
![Failed test](./resource/_md/img/img5.png)


5. At the bottom of the page you can find the attached artifacts
in the **Artifacts** section that contains the generated report.
![Artifacts-1](./doc/resource/_md/img/img6.png)
![Artifacts-2](./doc/resource/_md/img/img7.png)
![Artifacts-1](./resource/_md/img/img6.png)
![Artifacts-2](./resource/_md/img/img7.png)

6. Download and unzip it. There is file called `index.html`, inside
`report.zip` that is the generated report. It will look something like this
(set pretty option):

![report-1](./doc/resource/_md/img/img8.png)
![report-2](./doc/resource/_md/img/img9.png)
![report-1](./resource/_md/img/img8.png)
![report-2](./resource/_md/img/img9.png)

> **Note**: The status of the GitHub Action will be **Failure** :x:,
if any of the Test Cases that we are testing has an error,
Expand Down Expand Up @@ -514,25 +518,25 @@ file.

Example:

![zip](./doc/resource/_md/img/img10.png)
![zip](./resource/_md/img/img10.png)

Then, the executable should be uploaded to the corresponding release:

> **Note**: to do it with the command line see `gh release`
1. In the main page, go to *Releases*.

![Releases](./doc/resource/_md/img/img11.png)
![Releases](./resource/_md/img/img11.png)

2. Inside the latest release, go to *Edit*.

![Edit](./doc/resource/_md/img/img12.png)
![Edit](./resource/_md/img/img12.png)

3. Upload the executables in *Attach binaries by dropping them here or
selecting them* (leave all the other fields as they were).
Keep marked *Set as the latest release*, and press *Update release*.

![Attach](./doc/resource/_md/img/img13.png)
![Attach](./resource/_md/img/img13.png)

> **Note**: once the executable is uploaded, the user should run
> GitHub Actions to generate a new report.
Expand Down Expand Up @@ -603,11 +607,11 @@ The name of the release and the tag should be as explained in
1. In the main page, go to *Releases*.
![Releases](./doc/resource/_md/img/img11.png)
![Releases](./resource/_md/img/img11.png)
2. Go to *Draft a new release*.
![Draft a new release](./doc/resource/_md/img/img14.png)
![Draft a new release](./resource/_md/img/img14.png)
3. Do:
* In *Choose a tag* write the name of the tag and select
Expand All @@ -621,7 +625,7 @@ The name of the release and the tag should be as explained in
* Make sure *Set as pre-release* is **not selected**.
* Press *Publish release*.
![Create release](./doc/resource/_md/img/img15.png)
![Create release](./resource/_md/img/img15.png)
## Report Bugs
Expand All @@ -633,16 +637,16 @@ in the following way.
* Go to *Issues*.
![Issues](./doc/resource/_md/img/img16.png)
![Issues](./resource/_md/img/img16.png)
* **Check the issue is not already submitted**.
* Select *New Issue*.
![New issue](./doc/resource/_md/img/img17.png)
![New issue](./resource/_md/img/img17.png)
* Select Interoperability issue template, *Get Started*.
![Issue-Get started](./doc/resource/_md/img/img18.png)
![Issue-Get started](./resource/_md/img/img18.png)
* Fill out the corresponding information:
* Title: `Problem with <QoS or parameter>`
Expand All @@ -651,16 +655,16 @@ in the following way.
* Copy the link to the GitHub Action workflow run.
* Example, from this page:
![Artifacts-1](./doc/resource/_md/img/img6.png)
![Artifacts-1](./resource/_md/img/img6.png)
* Add any suggestion about how to fix it, or why
this is happening [Optional].
* Add another comment [Optional].
* In the section *Labels*, assign them to the vendors involved.
![Label-1](./doc/resource/_md/img/img19.png)
![Label-2](./doc/resource/_md/img/img20.png)
![Label-1](./resource/_md/img/img19.png)
![Label-2](./resource/_md/img/img20.png)
* Press *Submit new issue*.
![Template](./doc/resource/_md/img/img21.png)
![Template](./resource/_md/img/img21.png)

0 comments on commit a85376e

Please sign in to comment.