Re-write cli doc update workflow - #245
Draft
ChihweiLHBird wants to merge 1 commit into
Draft
Conversation
Signed-off-by: Zhiwei Liang <zhiwei.liang@zliang.me>
itowlson
reviewed
Aug 27, 2026
itowlson
left a comment
itowlson
left a comment
Contributor
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" |
Contributor
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.
Contributor
Author
There was a problem hiding this comment.
Yes, this is only a draft for now. Let me refine things
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.