-
Notifications
You must be signed in to change notification settings - Fork 206
Closed
Description
Description
Generate the 8.2.0 release notes and publish them before or on the release day, which is April 18.
Set up the release notes file
Follow these steps
- Check out the
mainbranch. - Run a
git fetch originthengit pullto pull in the latest changes. - Create a branch for the release notes, for example,
issue-XXX-8.2.0-rn. - Create an asciidoc file for the 8.2 release notes. Remember to specify the file extension and add a heading anchor to the top of the file.
- Insert a cross reference to the
8.2release notes section to update the page links on the release note's index page. - Add an include to the
release-notes.asciidocfile for the8.2release notes to update the release note's TOC. The include should be:include::release-notes/8.2.asciidoc[] - Open a PR.
NOTE: Make sure to add the correct labels. If the8.3branch is created before8.2GAs, will need to add thev8.3.0label to ensure the RN is backported to the8.3branch. - Complete the technical and editorial review, then merge the PR to
main.
Set up links for breaking changes
To link the "Breaking changes" section in the Security release notes from the Elastic Installation and Upgrade guide:
- Pull in the latest changes from the Stack doc's
mainbranch before creating a new branch to update thebreaking.asciidocfile in the Stack docs. - Make the following changes to the "Elastic Security breaking changes" section in the
breaking.asciidocfile:
- Update the release version number that's included in the URL that references the latest Security release notes. For this release, the referenced URL should be:
{security-guide-all}/8.2/release-notes-header-8.2.0.html#breaking-changes-8.2.0[{elastic-sec} breaking changes] - Update the include statement so it refences the
8.2release notes asciidoc file. For this release, ensure the include statement is:include::{security-repo-dir}/release-notes/8.2.asciidoc[tag=breaking-changes]
- Add the breaking changes tags to the "Breaking changes" section in the
8.2release notes asciidoc file. Here's what the section should look like:
[discrete]
[[breaking-changes-8.2.0]]
==== Breaking changes
// tag::breaking-changes[]
// NOTE: The breaking-changes tagged regions are re-used in the Elastic Installation and Upgrade Guide. The pull attribute is defined within this snippet so it properly resolves in the output.
:pull: https://github.com/elastic/kibana/pull/
**TBD**
// end::breaking-changes[]
Notes:
- Can model the issue and PR for updating the Stack doc's
breaking.asciidocfile after: - Remember to add a comment to the Stack docs PR that the PR's doc build will fail until the
8.2release notes page is available on the public docsite. This means that, in order for the8.2Stack docs PR to be successfully built, BOTH of the following requirements need to be met:- The
8.2Security release notes PR merged into main and backported to the8.2branch. - The
8.2Security release notes page will need to be built/published on the8.2branch and available on the public docsite.
- The