Skip to content

[DOCS] 8.2.0 Release Notes  #1723

@nastasha-solomon

Description

@nastasha-solomon

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

  1. Check out the main branch.
  2. Run a git fetch origin then git pull to pull in the latest changes.
  3. Create a branch for the release notes, for example, issue-XXX-8.2.0-rn.
  4. 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.
  5. Insert a cross reference to the 8.2 release notes section to update the page links on the release note's index page.
  6. Add an include to the release-notes.asciidoc file for the 8.2 release notes to update the release note's TOC. The include should be: include::release-notes/8.2.asciidoc[]
  7. Open a PR.
    NOTE: Make sure to add the correct labels. If the 8.3 branch is created before 8.2 GAs, will need to add the v8.3.0 label to ensure the RN is backported to the 8.3 branch.
  8. 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:

  1. Pull in the latest changes from the Stack doc's main branch before creating a new branch to update the breaking.asciidoc file in the Stack docs.
  2. Make the following changes to the "Elastic Security breaking changes" section in thebreaking.asciidoc file:
  • 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.2 release notes asciidoc file. For this release, ensure the include statement is: include::{security-repo-dir}/release-notes/8.2.asciidoc[tag=breaking-changes]
  1. Add the breaking changes tags to the "Breaking changes" section in the 8.2 release 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:

Metadata

Metadata

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions