cde40f4847
* Issue template stuff for creating megabranch * Fix placeholder YAML * update search indexes * update search indexes * update search indexes * update search indexes * update search indexes * update search indexes * update search indexes * update search indexes * update search indexes * update search indexes * update search indexes * update search indexes * update search indexes * Add release candidate banner * update search indexes * update search indexes * update search indexes * update search indexes * [GHES 3.2]: Remove final notes about machine man preview (GA) (#20939) * update search indexes * update search indexes * Add GHES versioning to "Managing your theme settings" (#20950) * update search indexes * [GHES 3.2]: Fix versioning for security alerts (#20761) * made a start * rework * move image to an enterprise 3.1 folder * forgot to commit * simplify reusable * update search indexes * update search indexes * update search indexes * Updated basic 3.2 REST fiels after package change These will be overwritten before release by the new description files when the 3.2 description is properly published * update search indexes * GHAE feature flag for `security alerts` custom notification option (#20979) * made a start * rework * move image to an enterprise 3.1 folder * forgot to commit * simplify reusable * add GHAE feature flag * remove spurious spaces I had added * update search indexes * update search indexes * update search indexes * update search indexes * update search indexes * update search indexes * update search indexes * Update versioning (#21121) Co-authored-by: Matt Pollard <mattpollard@users.noreply.github.com> * update search indexes * Add the new service (#21060) * update search indexes * update search indexes * update search indexes * Fix parent category index versioning for security overview * update search indexes * [GHES 3.2] Add documentation for GHES Referrer Policy Admin setting (#20910) Co-authored-by: jmarlena <6732600+jmarlena@users.noreply.github.com> Co-authored-by: Jules Parker <19994093+jules-p@users.noreply.github.com> Co-authored-by: Matt Pollard <mattpollard@users.noreply.github.com> * update search indexes * update search indexes * Update "Review hardware considerations" table (#21208) Performance improvements resulted in higher maximum job throughput and the new benchmarks need to be shared with current and potential customers. * update search indexes * Version new GHES 3.2 Actions tested performance (#21212) * update search indexes * Update "Review hardware considerations" table v2 Feedback from additional reviewers requires an update to the benchmarks previously merged. * update search indexes * update search indexes * [GHES 3.2] - Dependency Graph: Simplified enablement in GHES (GA) (#21078) * document UI button for dependency graph GHES 3.2 * update search indexes * Update getting-started-with-github-actions-for-github-enterprise-server.md * update search indexes * update search indexes * update search indexes * update search indexes * update search indexes * update search indexes * [GHES 3.2] Release candidate 1 release notes (#20799) Co-authored-by: Lucas Costi <lucascosti@users.noreply.github.com> Co-authored-by: bwestover <bwestover@github.com> Co-authored-by: Martin Lopes <martin389@github.com> Co-authored-by: Laura Coursen <lecoursen@github.com> Co-authored-by: Grey Baker <greysteil@github.com> Co-authored-by: Bas van Schaik <5082246+sj@users.noreply.github.com> Co-authored-by: William Bartholomew <iamwillbar@github.com> * update search indexes * update search indexes * update search indexes * update search indexes * update search indexes * Update OpenAPI Descriptions for GHES 3.2 (#21377) Also contains a rollup of other unmerged OpenAPI changes Co-authored-by: github-openapi-bot <github-openapi-bot@users.noreply.github.com> Co-authored-by: Lucas Costi <lucascosti@users.noreply.github.com> * update search indexes Co-authored-by: Rachael Sewell <rachmari@github.com> Co-authored-by: GitHub Actions <action@github.com> Co-authored-by: Docubot <67483024+docubot@users.noreply.github.com> Co-authored-by: Laura Coursen <lecoursen@github.com> Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Co-authored-by: mc <42146119+mchammer01@users.noreply.github.com> Co-authored-by: Felicity Chapman <felicitymay@github.com> Co-authored-by: Matt Pollard <mattpollard@users.noreply.github.com> Co-authored-by: Matthias Wenz <matthiaswenz@github.com> Co-authored-by: jmarlena <6732600+jmarlena@users.noreply.github.com> Co-authored-by: Jules Parker <19994093+jules-p@users.noreply.github.com> Co-authored-by: Steve-Glass <84886334+Steve-Glass@users.noreply.github.com> Co-authored-by: Meg Bird <megbird@github.com> Co-authored-by: bwestover <bwestover@github.com> Co-authored-by: Martin Lopes <martin389@github.com> Co-authored-by: Grey Baker <greysteil@github.com> Co-authored-by: Bas van Schaik <5082246+sj@users.noreply.github.com> Co-authored-by: William Bartholomew <iamwillbar@github.com> Co-authored-by: github-openapi-bot <69533958+github-openapi-bot@users.noreply.github.com> Co-authored-by: github-openapi-bot <github-openapi-bot@users.noreply.github.com>
Release notes for GitHub Enterprise Server
Rendered here: https://docs.github.com/en/enterprise-server@latest/admin/release-notes
How it works
Placeholder content file
A content file exists in content/admin/release-notes.md. It has a special frontmatter property layout: release-notes and no Markdown content. The source of the release notes comes from YAML data.
YAML source
The source data for the release notes lives in this directory (data/release-notes/enterprise-server).
The directories are named by GHES release number (with a hyphen instead of a period).
The YAML files in each directory are named by patch number. Some patch filenames may end with -rc<num>.yml, which means it's a release candidate. A release candidate file also requires release_candidate: true in the YAML data.
Release notes of deprecated GHES versions (see lib/enterprise-server-releases.js) are not removed from the site and will always be displayed alongside currently supported versions.
Note that patch files can be deprecated individually (i.e., hidden on the docs site) by an optional deprecated: true property.
Middleware processing
The YAML data is processed and sorted by middleware/contextualizers/release-notes.js and added to the context object.
Layouts
The context object data is rendered by components/release-notes.
The release notes page has a custom design with CSS in stylesheets/release-notes.scss.
Schema
The schema that validates the YAML data lives in tests/helpers/schemas/ghes-release-notes-schema.js. See the schema file to find out the required and optional properties.
The schema is exercised by a test in tests/linting/lint-files.js. The test will fail if the data does not pass validation.