New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature Request - Support JOB Markdown output #2325

Closed
damageboy opened this Issue Feb 9, 2017 · 5 comments

Comments

Projects
None yet
2 participants
@damageboy
Contributor

damageboy commented Feb 9, 2017

I would love for job's to be able to output markdown output text and have rundeck render it as pretty html.

It would be great if jobs could either be marked as outputting markdown or some sort of dynamic detection of Markdown output (perhaps by outputting a special line that "notifies" rundeck that the markdown "mode" is turned on.

@gschueler

This comment has been minimized.

Show comment
Hide comment
@gschueler

gschueler Feb 9, 2017

Member

@damageboy we have an idea where steps can output "attachments", e.g. data files or other preformatted output, so a markdown format would be rendered as html

Member

gschueler commented Feb 9, 2017

@damageboy we have an idea where steps can output "attachments", e.g. data files or other preformatted output, so a markdown format would be rendered as html

@damageboy

This comment has been minimized.

Show comment
Hide comment
@damageboy

damageboy Feb 9, 2017

Contributor

That's very nice.
How would this handle multiple attachments? Would those be displayed as "tabs" on the job output?
How would a default one be selected?

Is there an issue for this?

Contributor

damageboy commented Feb 9, 2017

That's very nice.
How would this handle multiple attachments? Would those be displayed as "tabs" on the job output?
How would a default one be selected?

Is there an issue for this?

@gschueler

This comment has been minimized.

Show comment
Hide comment
@gschueler

gschueler Feb 10, 2017

Member

@damageboy I don't think there is any issue for this yet, it is still in ideas phase. Any input is helpful, e.g. if you would like a script to output markdown and have it rendered in-line, that is a good use-case.

Member

gschueler commented Feb 10, 2017

@damageboy I don't think there is any issue for this yet, it is still in ideas phase. Any input is helpful, e.g. if you would like a script to output markdown and have it rendered in-line, that is a good use-case.

@damageboy

This comment has been minimized.

Show comment
Hide comment
@damageboy

damageboy Feb 12, 2017

Contributor

I would definitely be interested in "live" markdown support.

In my mind this play a long with a larger feature, that would mimic TeamCity Service Messages

The basic idea would be that "stuff" running under rundeck could detect rundeck's presence by testing something like a RUNDECK_VERSION env, variable...

Once it's detected, the scripts running can output various messages that customize the UI / Behaviour of rundeck a-la the service message bus mechanism of TeamCity.

For example a script could output something like:

##rundeck[progressMessage 'Deploying Version X.Y.Z']

Could alter run-decks step title dynamically from within a script

Or something like:

##rundeck[outputMode 'markdown']

Could toggle markdown interpenetration/rendering of the rest of the output...

Contributor

damageboy commented Feb 12, 2017

I would definitely be interested in "live" markdown support.

In my mind this play a long with a larger feature, that would mimic TeamCity Service Messages

The basic idea would be that "stuff" running under rundeck could detect rundeck's presence by testing something like a RUNDECK_VERSION env, variable...

Once it's detected, the scripts running can output various messages that customize the UI / Behaviour of rundeck a-la the service message bus mechanism of TeamCity.

For example a script could output something like:

##rundeck[progressMessage 'Deploying Version X.Y.Z']

Could alter run-decks step title dynamically from within a script

Or something like:

##rundeck[outputMode 'markdown']

Could toggle markdown interpenetration/rendering of the rest of the output...

@gschueler gschueler added this to the 2.9.0 milestone Jul 11, 2017

@gschueler

This comment has been minimized.

Show comment
Hide comment
@gschueler

gschueler Jul 11, 2017

Member

nb: rundeck 2.9 will support this with "Content converter" and "Log Filter" plugins. the 2.9 beta has this feature.

You can use the built in "Render Formatted Data" log filter plugin, to mark output from a step as markdown data. Then Rundeck will use a "content converter" which knows how to render Markdown to display it in the gui.

You can mark all output from a step with a certain data type, or you can use this syntax:

#BEGIN:RUNDECK:DATATYPE:<datatype>

Replacing <datatype> with one of the supported data types, e.g. markdown.

You can mark the section as ending by echoing:

#END:RUNDECK:DATATYPE
Member

gschueler commented Jul 11, 2017

nb: rundeck 2.9 will support this with "Content converter" and "Log Filter" plugins. the 2.9 beta has this feature.

You can use the built in "Render Formatted Data" log filter plugin, to mark output from a step as markdown data. Then Rundeck will use a "content converter" which knows how to render Markdown to display it in the gui.

You can mark all output from a step with a certain data type, or you can use this syntax:

#BEGIN:RUNDECK:DATATYPE:<datatype>

Replacing <datatype> with one of the supported data types, e.g. markdown.

You can mark the section as ending by echoing:

#END:RUNDECK:DATATYPE

@gschueler gschueler closed this Jul 11, 2017

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment