Need more documentation

[pjrt]

There is no README in the repo and there are no help buttons on the Jenkins UI.

This is a pretty complex plugin and would be awesome if there was some sort of documentation (either here or on the Jenkins UI, preferably the latter, maybe both).

[pjrt]

I was wrong, there is some documentation on the Jenkins UI (small little text under the actual checkboxes).

This should probably follow convention and use the info button.

I'm willing to do this, but I need more info on what exactly these buttons do. What is the difference between an unstable and unhealthy build? How do they behave differently? What does it mean to "Auto update threshold for health on successful build". What does it do if you don't set this?

[dalvizu]

https://wiki.jenkins-ci.org/display/JENKINS/Cobertura+Plugin ?

[ploutarchos]

That is an old issue, but that URL does not mention how the "Health auto update" and the other Jenkins cobertura options behave.

Is there any other URL?

That's what I currently get within my Jenkins:

[rwitzel]

Could you provide somewhere (in the wiki?) a link to the code that lists the options and their descriptions?

An example for the use in a pipeline (Groovy code) would be nice as well.

[ggetv]

+1, I tried to search but could not find the description on those config options as mentioned by @ploutarchos

In particular, can someone explain:

• what is the definition for "healthy", "stable" builds? It is something related to the sunny, stormy code coverage percentages?
• how the options like "health auto update" and "stability auto update" work?

I am looking for a solution that would fail the build if the code coverage drops (would be great even if we can give a min percentage value as well), e.g. if code coverage drops by more than 5%, then fail the build.

[ndelargy]

So, I had the same problem... I found more documentation by clicking Pipeline Syntax in the sidebar for the job

On the pipeline syntax page, on the sub page Steps Reference there's a list of the options for the cobertura command.

There's also a useful snippet generator.

This is enough to start experimenting

[svdHero]

Please do add an explanation of the plugin's options to the documentation. There are a couple of questions unanswered: What is an unhealthy build? What is an unstable build? How are those terms defined?

[ahvigil]

this becomes increasingly necessary given users like me who are using this plugin within the context of a pipeline defined in a Jenkinsfile, where we don't have the benefit of nifty little UI widgets that document the various options for us 😬. Its unfortunate when I have to look up the plugin source to figure out what the options are.

[UltimateGeek]

See also #111