Directives

DJ
Last updated 3 months ago

What are ReleasePage directives?

Directives

Directives allow you to describe pieces of metadata that can be passed into your Release Page for each release. This metadata allows extra information to be shown with each release.

Directives are written in yaml at the head of a release on GitHub.

The directives must also be within an HTML comment block to stop GitHub from showing it as part of the release.

The following directives are currently supported in the default templates; ​

Title

<!---
title: Release Page Title Directive
--->

Specify a title for this release. This is commonly used next to the version number for any additional information about the release.​​

Summary

<!---
summary: You can just provide a summary directive, or check out the release above to see a title and summary directive in use!
--->

Show a short summary or of this release. ​​​

Grouped

<!---
grouped: v0.2.0
title: Release Page Title Directive
summary: You can also provide a summary directive
--->

The grouped directive allows GitHub releases across multiple projects to be grouped within the same release on the Release Page.​​

Example Release

<!---
grouped: v1.0.1
title: Version 1.0.1, offered to all users November 25, 2016
summary: We'd also like to extend a special thank you to all of the new beta testers who helped contribute to this release!
--->