Whats is the format for custom pipeline library help files?

[Martin d'Anjou]

Hello,

We can write documentation for pipeline library in files like vars/foo.txt and resource/org/foo/bar.json, but I would like to know what format and markups are supported.

I found the help for the docker pipeline plugin, but it's written in jelly and after trying, jelly is not a supported format for the help files.

Thanks,

Martin

[Mark Waite]

https://github.com/jenkins-infra/pipeline-library/tree/master/vars  seems to include HTML markup in the txt file.  For example, runATH.txt starts with:

<p>
    Runs the <a href='https://github.com/jenkinsci/acceptance-test-harness'>Acceptance Test Harness</a> in a configurable way
</p>

 

--
You received this message because you are subscribed to the Google Groups "Jenkins Users" group.
To unsubscribe from this group and stop receiving emails from it, send an email to jenkinsci-use...@googlegroups.com.
To view this discussion on the web visit https://groups.google.com/d/msgid/jenkinsci-users/73becfdb-b513-450b-af2d-5822ef259e86%40googlegroups.com.

--

Thanks!

Mark Waite

[Martin d'Anjou]

Thank you Mark, this is a good set of examples.

But :-( it does not work. The markup is rendered verbatim, that is, it is treated as a plain text file.

And even when I add the jenkins-infra/pipeline-library to my jenkins instance, it shows the help files as text, there is no rendering of the markup.

It is not a critical thing.

Best,

Martin

 
On Friday, October 18, 2019 at 6:23:08 PM UTC-4, Mark Waite wrote:

https://github.com/jenkins-infra/pipeline-library/tree/master/vars  seems to include HTML markup in the txt file.  For example, runATH.txt starts with:

<p>
    Runs the <a href='https://github.com/jenkinsci/acceptance-test-harness'>Acceptance Test Harness</a> in a configurable way
</p>

 

On Fri, Oct 18, 2019 at 4:03 PM Martin d'Anjou <martin....@gmail.com> wrote:

Hello,

We can write documentation for pipeline library in files like vars/foo.txt and resource/org/foo/bar.json, but I would like to know what format and markups are supported.

I found the help for the docker pipeline plugin, but it's written in jelly and after trying, jelly is not a supported format for the help files.

Thanks,

Martin

--
You received this message because you are subscribed to the Google Groups "Jenkins Users" group.

To unsubscribe from this group and stop receiving emails from it, send an email to jenkins...@googlegroups.com.

To view this discussion on the web visit https://groups.google.com/d/msgid/jenkinsci-users/73becfdb-b513-450b-af2d-5822ef259e86%40googlegroups.com.

--

Thanks!

Mark Waite

[Reinhold Füreder]

Hi Martin,

 

This (markup rendering) works fine for me (with HTML markup used in “vars/foo.txt”); of course only once the build succeeds; but I guess you have a different problem (than non-successful builds), because otherwise it does not change at all or is rendered at all.

 

Maybe it also depends on markup formatter setting? E.g. via JCasC:

Jenkins:

 …

  markupFormatter:

    rawHtml:

      disableSyntaxHighlighting: false

  …

 

HTH Reinhold

To unsubscribe from this group and stop receiving emails from it, send an email to jenkinsci-use...@googlegroups.com.
To view this discussion on the web visit https://groups.google.com/d/msgid/jenkinsci-users/e7e88232-fcb2-4145-96a3-5c22ffc995a8%40googlegroups.com.

[Martin d'Anjou]

Thanks. That works. For the record, it was under the Configure Global Security section (not under configure system).

To view this discussion on the web visit https://groups.google.com/d/msgid/jenkinsci-users/e7e88232-fcb2-4145-96a3-5c22ffc995a8%40googlegroups.com.