From d10a22df0b7c6e56da9422072b90e3a65a20fbf8 Mon Sep 17 00:00:00 2001
From: Tim Smith <tsmith84@gmail.com>
Date: Thu, 31 Oct 2024 09:17:07 -0700
Subject: [PATCH] Add a make command to generate release notes (#433)

* 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 <tsmith84@gmail.com>

* Throw in some quotes

Signed-off-by: Tim Smith <tsmith84@gmail.com>

---------

Signed-off-by: Tim Smith <tsmith84@gmail.com>
---
 .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 5977f03f..eb4e779e 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 6395905b..7af5c977 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 00000000..0e9eaaff
--- /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