Release notes
Product name, a large version number and a single release headline.
The release notes template is a version announcement card. It sets the product name, a large version number such as v1.4.0 and a single release headline on one image, so the link to a release page or launch post shows what shipped and which version it is.
It takes four fields: the product name, the version, a headline, and an optional one-line summary. The version is the focal point of the card, which makes it easy to spot a new release in a crowded feed. Keep the headline to the single most important change and put the detail in the summary or on the page itself.
Render the card in the same CI job that tags the release and attach it to the release page, the announcement post and the docs. A background from the curated background pack can sit behind the text. For a card that lists several individual changes, use the changelog template instead.
- Version launch announcements
- Major and minor release posts
- SaaS release pages
- Release emails and social posts
Related: Quickstart · URL templates guide · API reference
Parameters
| Parameter | Type | Required | Limit |
|---|---|---|---|
product | string | Yes | up to 120 characters |
version | string | Yes | up to 120 characters |
headline | string | Yes | up to 300 characters |
summary | string | No | up to 120 characters |
Try it
POST /v1/images, Bearer-authenticated, with this template id and
params — see the quickstart for how to get a key, and for a
signed-URL example that links straight to a cacheable, cache-forever image URL without a
server round trip.
curl https://ogmake.com/v1/images \
-H "Authorization: Bearer og_live_..." \
-H "Content-Type: application/json" \
-d '{
"template": "release",
"params": {
"product": "Kitepath",
"version": "v1.4.0",
"headline": "Faster routing, offline mode",
"summary": "A rebuilt router and a new offline queue."
}
}'
