rollout-description markdown issues
complete
Ran Magen
- newlines in the JSON do not newline in dive
- standard markdown url notation doesn't print correctly
The yaml I posted has this part in the annotations piece (the <<: part works as expected for other fields, just the annotation value matters here)
<<: {
"dive.co/deployer": "Enrico2",
"dive.co/rollout-description":"+ [https://github.com/secret/shhhh/commit/421e71598](421e71598) | 2020-01-21 | Ran Magen | [https://apollographql.atlassian.net/browse/BE-871]([BE-871]) Get rollout description into Dive + more
+ [https://github.com/secret/shhhh/commit/d0fd03475](d0fd03475) | 2020-01-18 | Joshua Segaran | description... [https://github.com/secret/shhhh/pull/3390](#3390)
+ [https://github.com/secret/shhhh/commit/dd9970ede](dd9970ede) | 2020-01-17 | Joshua Segaran | description... [https://github.com/secret/shhhh/pull/3368](#3368)
+ [https://github.com/secret/shhhh/commit/d597909ea](d597909ea) | 2020-01-17 | Joshua Segaran | description... [https://github.com/secret/shhhh/pull/3386](#3386)
+ [https://github.com/secret/shhhh/commit/89686159d](89686159d) | 2020-01-16 | Jason Zukewich | description...
+ [https://github.com/secret/shhhh/commit/cea3ac5ee](cea3ac5ee) | 2020-01-17 | jgzuke | description...
",
"dive.co/git-sha" : "421e715980",
The result from
get deploy -oyaml
had some weird newlines: dive.co/deployer: Enrico2
dive.co/git-sha: 421e715980
dive.co/repo-name: shhhh
dive.co/repo-owner: secret
dive.co/rollout-description: '+ [https://github.com/secret/secret/commit/421e71598](421e71598)
| 2020-01-21 | Ran Magen | [https://apollographql.atlassian.net/browse/BE-871]([BE-871])
description... + [https://github.com/secret/secret/commit/d0fd03475](d0fd03475)
| 2020-01-18 | Joshua Segaran | description... [https://github.com/secret/secret/pull/3390](#3390)
+ [https://github.com/secret/secret/commit/dd9970ede](dd9970ede) | 2020-01-17
| Joshua Segaran | description... [https://github.com/secret/secret/pull/3368](#3368)
+ [https://github.com/secret/secret/commit/d597909ea](d597909ea) | 2020-01-17
| Joshua Segaran | description... [https://github.com/secret/secret/pull/3386](#3386)
+ [https://github.com/secret/secret/commit/89686159d](89686159d) | 2020-01-16
| Jason Zukewich | description...
+ [https://github.com/secret/secret/commit/cea3ac5ee](cea3ac5ee) | 2020-01-17
| jgzuke | description...'
dive.co/version: 2020.01-23-g421e715980
- Dive didn't newline
- Dive used the full link as the text instead of the only the part in round braces
See our event link events/1193
edit: This bug report system doesn't support triple quote markdown? :)
William Morgan
complete
Ran Magen
ok I fixed the bad markdown on my end. Looks good now! (with
<br/>
)William Morgan
Ran Magen: Great!!!
William Morgan
Ran Magen: I think your Markdown links are backwards: you're using
[link]
then (text)
but you should be doing [text]
then (link)
.In terms of newlines, currently Dive is using "classic" markdown in which newlines in the input are
not
automatically converted to newlines in the output. This is similar to how GitHub READMEs (but not comments, sigh) work.In this mode, you can force a linebreak with two spaces at the end of the line, or by adding
<br/>
.Let me know if this works for ya.
Ran Magen
William Morgan: ugh, my bad. Gonna try going back to this tomorrow.
William Morgan
Ran Magen: No worries. FWIW we've been using this feature internally and it's awesome. (We generate a bulleted list tho, which also addresses the linebreak issue.)
William Morgan
planned
Ran Magen
I tried adding
\n
and that showed another bug, the \
was not rendered, but the n
was.Jean Sandberg
Ran Magen: Thanks for the bug reports! We're on it.