Rundeck job description - include/insert file

[Roger McCarrick]

Rundeck 4.15

Edit job > Details Tab > Description 

I see that you can add a "ReadMe" by adding "---" and then anything under that will formatted with Markdeep.

Instead of typing in the whole ReadMe information in this Description box, can I include a file with all the info? A remote file? like https://server/file.htm or file.md? Or even just a local file?

Chatgpt was telling me that I could do something like:

{% include "https://server/rundeck/rddocs/{{job.id}}.md" %}

But that didn't work.

thanks

[Roger McCarrick]

Also in descriptions I want to add html links, which I can do, but include target="_blank" .. but the HTML sanitizer ruins that. Any way to change that?

[rac...@rundeck.com]

Hi Roger,

Rundeck only admits text in its editor, but you can reference that file using the markdown format.

this is a [Link](https://raw.githubusercontent.com/rundeck/rundeck/refs/heads/main/CODE_OF_CONDUCT.md)

It works on my end.

Regards.

​

[Roger McCarrick]

ya that works for me also ... but not they way I am looking for.
It gives me a link. It doesn't include the content of the link in the Readme.

[Roger McCarrick]

I can deal with just a link .. but is there anyway to make it open in a new window?
The Readme is a popup itself, so basically a new window.
Currently if u click on a link it opens in the current window and you lose the Rundeck window, you have to click back.
Of course you can use right click or ctrl-click .. but users don't usually do that.

[Roger McCarrick]

OK ....  I have this link

[Documentation](https://myApacheServer/rundeck/rddocs.shtml?file=e54b17a6-dd7c-4e87-bef5-bf44156d933a.html) 

" e54b17a6-dd7c-4e87-bef5-bf44156d933a" is the jobID hard coded into that link.

Anyway I can just make the link 
[Documentation](https://myApacheServer/rundeck/rddocs.shtml?file=$jobID.html) 

and Rundeck would substitute  $jobID with the actual ID ?

[rac...@rundeck.com]

Hi Roger,

I also tried job.id uncessfully. Only works with job.permalink, but this uses the entire job URL. So, please open a suggestion here.

thanks.

[Roger McCarrick]

Thanks .. I will add the suggestion ....
In the meantime .. I wrote a powershell script that uses the Rundeck API to get all projects, then for each project get all jobs.
Foreach job, I the test if there is a documentation file at https://myApacheServer/rundeck/$jobID.html
If there is, I set $docLink = "<br><br>[Documentation]($DocBaseURL$jobId.html) [SHIFT-CLICK to open in new window]"
I get the current description of the job, and if it doesn't already have the above documentation link in it, then add  $docLink to the end of the description.
Then write the whole new description to the job.

Now every job has that  $docLink in the description. The script will run daily, skip all the ones already done, and add  $docLink for any new jobs.