From 7f3c0262c519c4f5a7ca49babdc2597103920956 Mon Sep 17 00:00:00 2001 From: Tim Smith Date: Wed, 30 Oct 2024 13:28:37 -0700 Subject: [PATCH 1/2] Add a make command to generate release notes I was wasting time copying the last one each time and then changing things to make it a template that I could use for the next week. Why not automate this a bit? Signed-off-by: Tim Smith --- .github/actions/spelling/excludes.txt | 1 + Makefile | 13 +++++++++ releases/_release_template_file.md | 38 +++++++++++++++++++++++++++ 3 files changed, 52 insertions(+) create mode 100644 releases/_release_template_file.md diff --git a/.github/actions/spelling/excludes.txt b/.github/actions/spelling/excludes.txt index 5977f03fe..eb4e779e9 100644 --- a/.github/actions/spelling/excludes.txt +++ b/.github/actions/spelling/excludes.txt @@ -81,3 +81,4 @@ ignore$ \.zip$ ^\.github/actions/spelling/ ^\Q.github/workflows/spelling.yml\E$ +_release_template_file.md diff --git a/Makefile b/Makefile index 6395905b7..24b1a181b 100644 --- a/Makefile +++ b/Makefile @@ -18,6 +18,19 @@ build: yarn fmt serve: yarn fmt build yarn run serve +### +### Create a new release note +### + +.PHONY: notes +notes: + @echo "Generating new release note file\n\n" + @read -p 'What version should I use? ' VERSION; \ + read -p 'What date will this release ship (ex: 2024-11-05)? ' DATE; \ + cp ./releases/_release_template_file.md ./releases/$${DATE}-mondoo-$${VERSION}-is-out.md; \ + mkdir -p ./static/img/releases/$${DATE}-mondoo-$${VERSION}-is-out; \ + sed -i '' "s/VERSION/$${VERSION}/g" "./releases/$${DATE}-mondoo-$${VERSION}-is-out.md" + ### ### Caddy ### diff --git a/releases/_release_template_file.md b/releases/_release_template_file.md new file mode 100644 index 000000000..0e9eaaff7 --- /dev/null +++ b/releases/_release_template_file.md @@ -0,0 +1,38 @@ +--- +slug: mondoo-VERSION-is-out/ +title: Mondoo VERSION is out! +description: Announcing the VERSION release of Mondoo with FOO, BAR, BAZ, and more! +authors: [tim] +image: DEETS +tags: [release, mondoo] +--- + +## ๐Ÿฅณ Mondoo VERSION is out! This release includes FOO, BAR, BAZ, and more! + +Get this release: [Installation Docs](https://mondoo.com/docs/cnspec/) | [Package Downloads](https://releases.mondoo.com/cnspec/) | [Docker Container](https://hub.docker.com/r/mondoo/cnspec) + +--- + +## ๐ŸŽ‰ NEW FEATURES + +### FEATURE 1 + +DEETS + +## ๐Ÿงน IMPROVEMENTS + +### IMPROVEMENT 1 + +DEETS + +### Resource updates + +#### RESOURCE 1 + +- New `FIELD_NAME` field +- New `FIELD_NAME` field using the new `MQL.RESOURCE` resource + +## ๐Ÿ› BUG FIXES AND UPDATES + +- BUG 1 +- BUG 2 From f72502f94e636ca5d5a3eae89c8f3f6811de23f6 Mon Sep 17 00:00:00 2001 From: Tim Smith Date: Thu, 31 Oct 2024 09:05:29 -0700 Subject: [PATCH 2/2] Throw in some quotes Signed-off-by: Tim Smith --- Makefile | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Makefile b/Makefile index 24b1a181b..7af5c9770 100644 --- a/Makefile +++ b/Makefile @@ -27,8 +27,8 @@ notes: @echo "Generating new release note file\n\n" @read -p 'What version should I use? ' VERSION; \ read -p 'What date will this release ship (ex: 2024-11-05)? ' DATE; \ - cp ./releases/_release_template_file.md ./releases/$${DATE}-mondoo-$${VERSION}-is-out.md; \ - mkdir -p ./static/img/releases/$${DATE}-mondoo-$${VERSION}-is-out; \ + cp ./releases/_release_template_file.md "./releases/$${DATE}-mondoo-$${VERSION}-is-out.md"; \ + mkdir -p "./static/img/releases/$${DATE}-mondoo-$${VERSION}-is-out"; \ sed -i '' "s/VERSION/$${VERSION}/g" "./releases/$${DATE}-mondoo-$${VERSION}-is-out.md" ###