PR#38: brew-build.test.{complete,error}: add docs - fedora-ci/messages

fedora-ci / messages

#38 brew-build.test.{complete,error}: add docs

Merged 5 years ago by mvadkert. Opened 5 years ago by mvadkert.

fedora-ci/ mvadkert/messages rfe-docs into master

brew-build.test.{complete,error}: add docs

Miroslav Vadkerti • 5 years ago

e3f4758

examples/brew-build.test.complete.json

file modified

+2 -1

		`@@ -35,6 +35,7 @@`
		`"variant": "Server",`
		`"label": "master"`
		`}],`
		`+ "docs": "https://my-ci-system/docs/contribute-retrigger-reproduce",`
		`"type": "tier1",`
		`"category": "functional",`
		`"status": "failed",`
		`@@ -46,5 +47,5 @@`
		`"web_url": "https://dashboard.com/job/4794/",`
		`"note": "Some notes.",`
		`"generated_at": "2018-05-10 08:58:31.222602",`
		`- "version": "0.1.0"`
		`+ "version": "0.1.3"`
		`}`

examples/brew-build.test.error.json

file modified

+2 -1

		`@@ -25,6 +25,7 @@`
		`"scratch": true,`
		`"dependencies": ["gcc-3.8.2-1.el7", "make-2.3.1-2.el7_4"]`
		`},`
		`+ "docs": "https://my-ci-system/docs/contribute-retrigger-reproduce",`
		`"type": "tier1",`
		`"category": "functional",`
		`"label": "slow",`
		`@@ -35,5 +36,5 @@`
		`"note": "Operation team was notified about the issue, follow the Sentry issue link",`
		`"namespace": "baseos-qe.baseos-ci",`
		`"generated_at": "2018-05-10 08:58:31.222602",`
		`- "version": "0.1.0"`
		`+ "version": "0.1.3"`
		`}`

schemas/brew-build.test.complete.yaml

file modified

		`@@ -16,6 +16,8 @@`
		`type: array`
		`items:`
		`$ref: system.json`
		`+ docs:`
		`+ $ref: common.json#properties/docs`
		`category:`
		`$ref: common.json#properties/category`
		`type:`

schemas/brew-build.test.error.yaml

file modified

		`@@ -14,6 +14,8 @@`
		`$ref: run.json`
		`artifact:`
		`$ref: rpm-build.json`
		`+ docs:`
		`+ $ref: common.json#properties/docs`
		`category:`
		`$ref: common.json#properties/category`
		`type:`

schemas/common.yaml

file modified

+13 -2

		`@@ -17,6 +17,17 @@`
		`- functional`
		`- integration`
		`type: string`
		`+ docs:`
		`+ description:`
		`+ Provides link to documentation for testing events`
		`+ for distributed CI systems to make them sustainable.`
		`+ Should contain information about how to contribute to the`
		`+ specific test, how to reproduce it, ideally on localhost`
		`+ and how to retrigger the test.`
		`+ examples:`
		`+ - https://my-ci-system/docs`
		`+ type: string`
		`+ format: uri`
		`generated_at:`
		`description:`
		`Time when the requested was generated. This can be useful to track`
		`@@ -140,9 +151,9 @@`
		`version:`
		`description:`
		`Version of the specification. Following semantic versioning`
		`- (https://semver.org/). Current version is 0.1.1.`
		`+ (https://semver.org/). Current version is 0.1.3.`
		`examples:`
		`- - 0.1.1`
		`+ - 0.1.3`
		`type: string`
		`web_url:`
		`description:`

mvadkert commented 5 years ago

This PR adds links to guides for contribution, reproduction and
retriggering. These are required to make the distributed CI systems
sustainable.

Resolves RHELPLAN-12730

Signed-off-by: Miroslav Vadkerti mvadkert@redhat.com

rebased onto e12ace9e1324ef6f8369953a582d00ede95b333f

5 years ago

psss commented 5 years ago

Does there really need to be three separate documentation links? Seems to me that the core point is to have documented contributing, triggering and reproducing. But I'm not convinced that we should introduce so many fields for this. Plus we already have docs under the ci section.

Edited 5 years ago by psss

mvadkert commented 5 years ago

yeah, it depends, maybe not, but I wanted to be able to reference each step nicely in notifications .....

mvadkert commented 5 years ago

Once with 0.2.0 out this docs will get to test.docs ... nice

rebased onto 5e7fcb17ef51fa846d529b5559b4d8ca11d674fa

5 years ago

mvadkert commented 5 years ago

Fixed, @psss could you take a look again? Note that with 0.2.0 this will become test.docs, so better name would be now test-docs, but :bike: shedding :)

happz commented 5 years ago

Shouldn't the version change as well, since the patch is adding new fields?

psss commented 5 years ago

Shouldn't the version change as well, since the patch is adding new fields?

Would that mean a new duplicate/copy of all examples and schemas again? I think in the log run this would be unbearable. See also my comment in version 0.2.0 pull request.

happz commented 5 years ago

So what's the point of having aversion field then?

If it's not reliable and cannot be used for deciding whether a field foo should or should not be in the message. If it's not smart or sustainable to clone schemas for new versions, sure, let's get rid of it and call it a dumb idea - my concerns was the access to older schemas, because by introducing a new version of schema doesn't cause everyone to stop using the old, which I'd still like to see verified. If copy is too much, let's find something smarter.

mvadkert commented 5 years ago

Let's just merge this guys, and do proper versioning from 0.2.0, when we introduce folders for version. I can definitely raise the version here though ....

psss commented 5 years ago

Thanks for the update. Looks better. I guess the schemas/docs.yaml file should now be dropped?

mvadkert commented 5 years ago

yes .. dropping

rebased onto 08f0df7dc57a83e04d05da87d4812c595172cb51

5 years ago

mvadkert commented 5 years ago

dropped .. also raising version to 0.1.3

rebased onto df27eacab5a822b9e926ca05a60ffb56377e68fd

5 years ago

rebased onto e3f4758

5 years ago