Skip to content

Commit

Permalink
Add a make command to generate release notes
Browse files Browse the repository at this point in the history
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>
  • Loading branch information
tas50 committed Oct 30, 2024
1 parent 16c5b7f commit 7f3c026
Show file tree
Hide file tree
Showing 3 changed files with 52 additions and 0 deletions.
1 change: 1 addition & 0 deletions .github/actions/spelling/excludes.txt
Original file line number Diff line number Diff line change
Expand Up @@ -81,3 +81,4 @@ ignore$
\.zip$
^\.github/actions/spelling/
^\Q.github/workflows/spelling.yml\E$
_release_template_file.md
13 changes: 13 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -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
###
Expand Down
38 changes: 38 additions & 0 deletions releases/_release_template_file.md
Original file line number Diff line number Diff line change
@@ -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

0 comments on commit 7f3c026

Please sign in to comment.