submitter_guide: add sections on issues and incidents #426
Conversation
|
please review added sections @spbnick, am i on right track |
|
|
||
| ##### `culprit` | ||
| The layers of the execution stack responsible for the issue | ||
| It can be one of the following properties |
There was a problem hiding this comment.
"It can contain one or more of the following properties" would be more correct.
doc/submitter_guide.md
Outdated
|
|
||
| * `Code` - the built or tested code, value is boolean | ||
| * `Tool` - the static analyzer, the build toolchain, the test, etc | ||
| * `Harness` - the system controlling the execution of the build. |
There was a problem hiding this comment.
Each of these properties is all-lower-case, and should be listed as such, as anything else won't be accepted by the schema. All these properties are boolean, so perhaps just mention that in the paragraph above.
| * `FAIL` - the test has failed, the tested code is faulty. | ||
| * `PASS` - the test has passed, the tested code is correct. | ||
| * `DONE` - the test has finished successfully, the status of the tested code | ||
| is unknown. |
There was a problem hiding this comment.
This is an incomplete list of possible status strings. It might be better to just refer to the description of the test status field above, as they're the same type.
There was a problem hiding this comment.
@spbnick i reffered to the test:status section, the available status strings there are: Error, Fail, Pass, Done, Skip. That was what i also included
| * `Tool` - the static analyzer, the build toolchain, the test, etc | ||
| * `Harness` - the system controlling the execution of the build. | ||
|
|
||
| #### Incidents |
There was a problem hiding this comment.
This could use a general description of what these objects are about and for.
| @@ -312,6 +312,41 @@ Date/Time Format][datetime_format]. | |||
|
|
|||
| Example: `"2020-08-14T23:41:54+00:00"` | |||
|
|
|||
| #### Issues | |||
There was a problem hiding this comment.
This could use a general description of what these objects are about and for.
|
|
||
| ##### `origin` | ||
| The name of the CI system which submitted the incident | ||
|
|
There was a problem hiding this comment.
This is missing the crucial fields linking issues and builds/tests together.
NikkyXO
force-pushed
the
update_submitter_guide_to_use_v4.1_schema-v2
branch
from
9d43a8b
to
1f98d93
Compare
I made recommended changes @spbnick |
doc/submitter_guide.md
Outdated
| ##### `build_valid` | ||
| The status to assign to incident builds | ||
|
|
||
| Example: `"build_valid": false` |
There was a problem hiding this comment.
It's enough to just show the value in the example, like the existing examples for all other properties. No need to also show the property name.
I.e. this:
Example: `false`And not this:
Example: `"build_valid": false`Here and everywhere else.
doc/submitter_guide.md
Outdated
|
|
||
| #### Incidents | ||
| The following properties are used to describe an issue occurrence or absence of it | ||
| ======= |
There was a problem hiding this comment.
This line shouldn't be here, as we're not formatting a title.
doc/submitter_guide.md
Outdated
| ##### `comment` | ||
| A human-readable comment regarding the incident | ||
|
|
||
| Example: `"comment": "<An human readable comment in string>"` |
There was a problem hiding this comment.
Could you make up a comment that would be suitable for an incident?
doc/submitter_guide.md
Outdated
|
|
||
|
|
||
|
|
||
| ======= |
There was a problem hiding this comment.
This line and the extra whitespace above shouldn't be here. Just one blank line would be enough.
doc/submitter_guide.md
Outdated
| A human-readable comment regarding the incident | ||
|
|
||
|
|
||
|
|
There was a problem hiding this comment.
Just one blank line would be more appropriate here.
submitter_guide: add sections on issues and incidents
NikkyXO
force-pushed
the
update_submitter_guide_to_use_v4.1_schema-v2
branch
from
1f98d93
to
bdc73d6
Compare
No description provided.