Skip to main content

Release note content type

Release notes enable readers to understand and prepare for the user-facing changes in each release of GitHub's versioned enterprise products.

Good release notes provide administrators the necessary information to plan system upgrades in environments that require change control, and support end users who want to understand and prepare to use new GitHub features and functionality.

Writers source, edit, and publish release notes in collaboration with product DRIs, feature owners, and individual engineers at GitHub. For each individual release, we group release notes by predefined types.

We publish the release notes for GitHub Enterprise Server on GitHub Docs, in the "Enterprise administrators" documentation set.

Types of releases

GitHub Docs provides release notes for feature releases and patch releases of GitHub Enterprise Server. For more information, see "About upgrades to new releases" in the GitHub Enterprise Server documentation.

Guidance and example release notes

You can review guidance for the format, style, and tone of release notes, as well as examples of each type of note. For more information, see "Style guide".