-
Notifications
You must be signed in to change notification settings - Fork 80
chore: Generate clog from template #200
Conversation
|
✨ Coder.com for PR #200 deployed! It will be updated on every commit.
|
| description: "Released on <% MM/DD/YYYY %>" | ||
| --- | ||
|
|
||
| ### Breaking Changes ❗ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I love the cutesy emojis btw
@khorne3 mentioned we should use sentence case for lower-level headings, so I think this would be "Breaking changes" ?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If we do that, we should update all clogs. Happy for us to do that, though as a different changeset. I'm super glad we're increasing our consistency and standardizing these decisions!!!!! ❤️
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
btw, and it pains me a bit to say this, because I love the emojis, but... the emojis result in slightly worse fragments: https://coder.com/docs/changelog/1.17.0#breaking-changes- (note the trailing hyphen)
I dunno if there's some way to customize this in the JavaScript we're using to transform the Markdown, though
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Worth investigating - CH story would be useful as that's the responsibility of m, not anything in cdr/docs AFAICT
Co-authored-by: Jonathan Yu <jonathan@coder.com>
Co-authored-by: Jonathan Yu <jonathan@coder.com>
|
Webpack seems displeased with your addition! From the Vercel logs (just a warning though): |
Resolves: #63
Summary
A simplistic shell script for creating new changelogs from a template
Details
Adds
scripts/create-clog.sh <version> <release-date>utility.Note
I did not try to use
jqor some other means to add the changelog tomanifest.json. I started down that path, but there were some quirks (example sorting) and writing back to the file properly, that I feel it wasn't worth the effort for the time being.