submitter_guide: add sections on issues and incidents by NikkyXO · Pull Request #426 · kernelci/kcidb

NikkyXO · 2023-04-04T15:12:32Z

No description provided.

NikkyXO · 2023-04-04T15:13:31Z

please review added sections @spbnick, am i on right track

spbnick

This is a good start, you get the idea of giving a limited description, which is easier to grasp. Apart from the inline comments, it would also be good to give an example of value for each field.

spbnick · 2023-04-11T13:52:51Z

doc/submitter_guide.md

+
+##### `culprit`
+The layers of the execution stack responsible for the issue
+It can be one of the following properties


"It can contain one or more of the following properties" would be more correct.

spbnick · 2023-04-11T13:53:42Z

doc/submitter_guide.md

+
+* `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.


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.

spbnick · 2023-04-11T13:54:50Z

doc/submitter_guide.md

+* `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.


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.

@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

spbnick · 2023-04-11T13:55:24Z

doc/submitter_guide.md

+* `Tool` - the static analyzer, the build toolchain, the test, etc
+* `Harness` - the system controlling the execution of the build.
+
+#### Incidents


This could use a general description of what these objects are about and for.

spbnick · 2023-04-11T13:56:03Z

doc/submitter_guide.md


 Example: `"2020-08-14T23:41:54+00:00"`

+#### Issues


This could use a general description of what these objects are about and for.

spbnick · 2023-04-11T13:56:31Z

doc/submitter_guide.md

+
+##### `origin`
+The name of the CI system which submitted the incident
+


This is missing the crucial fields linking issues and builds/tests together.

NikkyXO · 2023-04-16T16:37:22Z

This is a good start, you get the idea of giving a limited description, which is easier to grasp. Apart from the inline comments, it would also be good to give an example of value for each field.

I made recommended changes @spbnick

spbnick

Thank you, @NikkyXO. I left a few inline comments concerning your new changes. There are also some of the old ones to resolve.

spbnick · 2023-04-21T09:49:07Z

doc/submitter_guide.md

+##### `build_valid`
+The status to assign to incident builds
+
+Example: `"build_valid": false`


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.

spbnick · 2023-04-21T09:49:39Z

doc/submitter_guide.md

+
+#### Incidents
+The following properties are used to describe an issue occurrence or absence of it
+=======


This line shouldn't be here, as we're not formatting a title.

spbnick · 2023-04-21T09:50:34Z

doc/submitter_guide.md

+##### `comment`
+A human-readable comment regarding the incident
+
+Example: `"comment": "<An human readable comment in string>"`


Could you make up a comment that would be suitable for an incident?

spbnick · 2023-04-21T09:51:02Z

doc/submitter_guide.md

+
+
+
+=======


This line and the extra whitespace above shouldn't be here. Just one blank line would be enough.

spbnick · 2023-04-21T09:51:19Z

doc/submitter_guide.md

+A human-readable comment regarding the incident
+
+
+


Just one blank line would be more appropriate here.

submitter_guide: add sections on issues and incidents

NikkyXO had a problem deploying to staging April 4, 2023 15:21 — with GitHub Actions Failure

spbnick requested changes Apr 11, 2023

View reviewed changes

NikkyXO force-pushed the update_submitter_guide_to_use_v4.1_schema-v2 branch from 9d43a8b to 1f98d93 Compare April 16, 2023 16:31

NikkyXO requested a review from spbnick April 16, 2023 16:36

NikkyXO had a problem deploying to staging April 16, 2023 16:43 — with GitHub Actions Failure

spbnick requested changes Apr 21, 2023

View reviewed changes

submitter_guide: add sections on issues and incidents

bdc73d6

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 April 28, 2023 13:13

NikkyXO requested a review from spbnick April 28, 2023 13:18

NikkyXO had a problem deploying to staging April 28, 2023 13:25 — with GitHub Actions Failure


		##### `origin`
		The name of the CI system which submitted the incident




		=======

Conversation

NikkyXO commented Apr 4, 2023

Uh oh!

NikkyXO commented Apr 4, 2023

Uh oh!

spbnick left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

NikkyXO commented Apr 16, 2023

Uh oh!

spbnick left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants