Skip to content
This repository was archived by the owner on Aug 18, 2025. It is now read-only.

Conversation

@greyscaled
Copy link
Contributor

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 jq or some other means to add the changelog to manifest.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.

@greyscaled greyscaled added the chore 🔧 A chore in the codebase; non user-facing label Mar 23, 2021
@greyscaled greyscaled requested a review from jawnsy March 23, 2021 19:03
@greyscaled greyscaled self-assigned this Mar 23, 2021
@github-actions github-actions bot requested a deployment to codercom-preview-docs March 23, 2021 19:04 Pending
@github-actions
Copy link
Contributor

github-actions bot commented Mar 23, 2021

✨ Coder.com for PR #200 deployed! It will be updated on every commit.

description: "Released on <% MM/DD/YYYY %>"
---

### Breaking Changes ❗
Copy link

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" ?

Copy link
Contributor Author

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!!!!! ❤️

Copy link

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

Copy link
Contributor Author

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

greyscaled and others added 2 commits March 23, 2021 14:11
Co-authored-by: Jonathan Yu <jonathan@coder.com>
Co-authored-by: Jonathan Yu <jonathan@coder.com>
@github-actions github-actions bot requested a deployment to codercom-preview-docs March 23, 2021 19:11 Pending
@github-actions github-actions bot requested a deployment to codercom-preview-docs March 23, 2021 19:16 Pending
@jawnsy
Copy link

jawnsy commented Mar 23, 2021

Webpack seems displeased with your addition! From the Vercel logs (just a warning though):

12:21:48.391 | ./docs/scripts/create-clog.sh 1:0
12:21:48.391 | Module parse failed: Unexpected character '#' (1:0)
12:21:48.391 | You may need an appropriate loader to handle this file type, currently no loaders are configured to process this file. See https://webpack.js.org/concepts#loaders
12:21:48.391 | > #!/usr/bin/env bash
12:21:48.391 | \| #
12:21:48.392 | \| # create-clog.sh <version> <release-date>

@github-actions github-actions bot requested a deployment to codercom-preview-docs March 23, 2021 19:51 Pending
@github-actions github-actions bot requested a deployment to codercom-preview-docs March 23, 2021 19:55 Pending
@greyscaled greyscaled merged commit c886756 into master Mar 23, 2021
@greyscaled greyscaled deleted the vapurrmaid/clog-helper branch March 23, 2021 20:04
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

chore 🔧 A chore in the codebase; non user-facing

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Helper Scripts for Changelogs

2 participants