Add script to generate github markdown for release notes #1487
Conversation
This file contains 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
Codecov Report
@@ Coverage Diff @@
## main #1487 +/- ##
=======================================
Coverage 100.0% 100.0%
=======================================
Files 223 223
Lines 15139 15139
=======================================
Hits 15132 15132
Misses 7 7 Continue to review full report at Codecov.
|
dsherry
requested review from
angela97lin,
freddyaboulton,
bchen1116,
jeremyliweishih and
ParthivNaresh
angela97lin
reviewed
Dec 2, 2020
jeremyliweishih
previously requested changes
Dec 2, 2020
dsherry
force-pushed
the
ds_release_github_markdown_formatter
branch
from
2f9c1ab
to
99d9478
Compare
dsherry
commented
Dec 2, 2020
| date_formatted=$(date '+%b. %-d, %Y') | ||
| content_markdown=$(echo -n "${content_raw}" | sed 's/^ \* /- /g' | sed 's/^ \* /### /g' | sed 's/ \*\*Breaking Changes\*\*/### Breaking Changes/g' | sed -E "s/:pr:\`([0-9]+)\`/#\1/g") | ||
| full_markdown=$(echo -e "# v${evalml_version} ${date_formatted}\n${content_markdown}") | ||
| echo -e "${full_markdown}" |
There was a problem hiding this comment.
@angela97lin @jeremyliweishih I think I fixed the hard-coding here, and I broke things up so it should be a bit easier to follow! It was pretty soupy before.
@angela97lin you mentioned this is like magic--I agree, unix utilities are beautiful magic ✨ quick breakdown of what's going on:
- The "|" operator is the unix pipe mechanism which passes output along to subsequent commands
var=$(...): evaluating commands in sub-shells to save the output.sedis a super handy find-replace utility. I used it on line 12 to define a regex group and extract the matching version number asevalml_version- Then by including "p" and "q" commands with
sedon line 13, we're telling it to print everything after a match or to print everything up to a match, respectively. That lets us get all the lines between the last release header (i.e. the one about to go out) and the release header before that. tail,sed '$ d'andawk 'NF'are just hacks to remove leading/trailing lines and whitespace- The usage of
datebelow gets the date in the exact human-readable format we use it in our release notes. - The markdown part just uses a sequence of
sedcommands to replace specific line prefixes with their markdown counterparts, and then to convert our pr tags to use a hash for markdown. - Finally we put it all together in
full_markdownand output the result at the end!
freddyaboulton
approved these changes
Dec 2, 2020
There was a problem hiding this comment.
Very cool @dsherry ! I just tested it out locally and it works as expected!
Thanks for explaining what was happening with all of the sed and awk commands.
dsherry
force-pushed
the
ds_release_github_markdown_formatter
branch
from
99d9478
to
98ef7e9
Compare
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Usage:
tools/format_format_release_notes.shto print out the markdown to paste into the release PR and github releaseIt was only a matter of time 😂 https://xkcd.com/1319/