Release notes templates¶

Copy one of these templates into the body of the draft GitHub release, then fill in the placeholders. The files live under dev_scripts/templates/ in the repository.

Regular release¶

dev_scripts/templates/release-notes-regular.md:

This release includes various new features, stability improvements, and security fixes **(adjust accordingly)**.

The highlights for this release are:
  - **Important accomplishment**
    We used to do [this](https://github.com/freedomofpress/dangerzone/issues/1), but now we do [that](https://github.com/freedomofpress/dangerzone/issues/2).
  - **Support for a new platform**
    We added support for a new platform ([#3](https://github.com/freedomofpress/dangerzone/issues/3))
  - **Community contributions**
     <!-- Acknowledge all contributions and talk about highlights ->

For a full list of the changes, see our [changelog](https://github.com/freedomofpress/dangerzone/blob/<RELEASE_TAG>/CHANGELOG.md#<RELEASE_ANCHOR>).

Security release¶

dev_scripts/templates/release-notes-security.md:

This is a security release that mainly addresses CVE-XXXX-XXX. Our [security advisory](https://github.com/freedomofpress/dangerzone/blob/<RELEASE_TAG>/docs/advisories/<YYYY-MM-DD>.md) follows:

<!-- Vulnerability description for non-technical users -->

**To reduce that risk, you are strongly advised to update Dangerzone to the latest version**.

# Summary

# How does this impact me?

# What do I need to do?

You are **strongly** advised to update your Dangerzone installation to <VERSION> as soon as possible.


---

On other news, this release brings a fix for ([#4](https://github.com/freedomofpress/dangerzone/issues/4)) and a fix for ([#5](https://github.com/freedomofpress/dangerzone/issues/5))

For a full list of the changes, see our [changelog](https://github.com/freedomofpress/dangerzone/blob/<RELEASE_TAG>/CHANGELOG.md#<RELEASE_ANCHOR>).

The security template mirrors the structure of our security advisories.