What Release Notes file format should be for optimal display?

konstantine's Avatar

konstantine

07 Jan, 2017 03:41 AM

octo create-release takes --releasenotesfile parameter. We try to generate release notes by combining together messages from the relevant Git commits. How shall we format release notes file (before feeding it to Octo) so that it is optimally displayed in Octopus Web UI?
I could not find it documented anywhere.
Shall it be one commit per line? Are tabs important?
Is there a way to include hyperlinks (to TeamCity) to release notes so that they are clickable?
Please clarify.

Thank you!
Konstantin

  1. Support Staff 1 Posted by Dalmiro Grañas on 08 Jan, 2017 02:41 PM

    Dalmiro Grañas's Avatar

    Hi Konstantin,

    The Release Notes in Octopus can be formatted using Markdown (and only that). Here's a quick reference of its syntax: https://en.support.wordpress.com/markdown-quick-reference/

    Best regards,
    Dalmiro

  2. 2 Posted by konstantine on 08 Jan, 2017 05:06 PM

    konstantine's Avatar

    This is actually very good and sufficient for most purposes, but it MUST be added to documentation. There is no way to guess about it.

  3. Support Staff 3 Posted by Dalmiro Grañas on 09 Jan, 2017 05:46 PM

    Dalmiro Grañas's Avatar

    Hi Konstantine,

    I agree with you on this one. I've created a github issue to get this done: https://github.com/OctopusDeploy/Issues/issues/3056

    Regards,
    Dalmiro

Reply to this discussion

Internal reply

Formatting help / Preview (switch to plain text) No formatting (switch to Markdown)

Attaching KB article:

»

Attached Files

You can attach files up to 10MB

If you don't have an account yet, we need to confirm you're human and not a machine trying to post spam.

Keyboard shortcuts

Generic

? Show this help
ESC Blurs the current field

Comment Form

r Focus the comment reply box
^ + ↩ Submit the comment

You can use Command ⌘ instead of Control ^ on Mac