What Release Notes file format should be for optimal display?

Legacy Execution
1

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

2

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

3

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.

4

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