Re-write cli doc update workflow - #245
Conversation
itowlson
left a comment
itowlson
left a comment
There was a problem hiding this comment.
Thank you for picking this up and making something of it!
| exit 1 | ||
| fi | ||
| spin maintenance generate-reference -o "$RUNNER_TEMP/reference.md" | ||
| sed -n '1,/^---$/p' "$DOC" > "$RUNNER_TEMP/doc.md" |
There was a problem hiding this comment.
I would value a brief "how it works" comment around here. My guess is that sed is copying the first few lines of the existing doc and then we are catting the Markdown onto that, but I am not sure. Also not clear to my why we generate-to-a-separate-file-then-cat rather than generate-appending as before. Not that it matters, but for understanding.
There was a problem hiding this comment.
Yes, this is only a draft for now. Let me refine things
87c5046 to
26bde5c
Compare
Signed-off-by: Zhiwei Liang <zhiwei.liang@zliang.me>
26bde5c to
de06432
Compare
itowlson
left a comment
itowlson
left a comment
There was a problem hiding this comment.
This looks good to me and should help us with consistency. Thanks!
|
@fibonacci1729 You are way bashier than I am, do you have bandwidth to take a quick look please? |
2 participants
No description provided.