Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add a make command to generate release notes #433

Merged
merged 2 commits into from
Oct 31, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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"
philipbalinov marked this conversation as resolved.
Show resolved Hide resolved

###
### 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
Loading