You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Generate the 8.3.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 main branch.
Run a git fetch origin then git pull to pull in the latest changes.
Create a branch for the release notes, for example, issue-XXX-8.3.0-rn.
Create an asciidoc file for the 8.3 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.3 release notes section to update the page links on the release note's index page.
Add an include to the release-notes.asciidoc file for the 8.3 release notes to update the release note's TOC. The include should be: include::release-notes/8.3.asciidoc[]
Open a PR. NOTE: Make sure to add the correct labels. If the 8.3 branch is created before 8.3 GAs, will need to add the v8.3.0 label to ensure the RN is backported to the 8.3 branch.
Complete the technical and editorial review, then merge the PR to main.
Set up links for breaking changes
The content in the "Breaking changes" section is shared with the Elastic Installation and Upgrade guide using an include of tagged content. 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-docs repo's main branch before creating a new branch to update the breaking.asciidoc file in stack-docs.
Make the following changes to the "Elastic Security breaking changes" section in the breaking.asciidoc file:
Update the release version numbers included in the URL that references the latest Security release notes. For this release, the referenced URL should be: {security-guide-all}/8.3/release-notes-header-8.3.0.html#breaking-changes-8.3.0[{elastic-sec} breaking changes]
Update the include statement so it references the 8.3 release notes asciidoc file. For this release, ensure the include statement is: include::{security-repo-dir}/release-notes/8.3.asciidoc[tag=breaking-changes]
Ensure that the breaking changes tags are applied before and after the content of the "Breaking changes" section in the 8.3 release notes asciidoc file. Here's what the section should look like:
[discrete]
[[breaking-changes-8.3.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.asciidoc file after:
Remember to add a comment to the Stack docs PR that the PR's doc build will fail until the 8.3 release notes page is available on the public docsite. This means that, in order for the 8.3 Stack docs PR to be successfully built, BOTH of the following requirements need to be met:
The 8.3 Security release notes PR merged into main and backported to the 8.3 branch.
The 8.3 Security release notes page will need to be built/published on the 8.3 branch and available on the public docsite.
The text was updated successfully, but these errors were encountered:
Description
Generate the 8.3.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
main
branch.git fetch origin
thengit pull
to pull in the latest changes.issue-XXX-8.3.0-rn
.8.3
release notes section to update the page links on the release note's index page.release-notes.asciidoc
file for the8.3
release notes to update the release note's TOC. The include should be:include::release-notes/8.3.asciidoc[]
NOTE: Make sure to add the correct labels. If the
8.3
branch is created before8.3
GAs, will need to add thev8.3.0
label to ensure the RN is backported to the8.3
branch.main
.Set up links for breaking changes
The content in the "Breaking changes" section is shared with the Elastic Installation and Upgrade guide using an include of tagged content. To link the "Breaking changes" section in the Security release notes from the Elastic Installation and Upgrade guide:
stack-docs
repo'smain
branch before creating a new branch to update thebreaking.asciidoc
file instack-docs
.breaking.asciidoc
file:{security-guide-all}/8.3/release-notes-header-8.3.0.html#breaking-changes-8.3.0[{elastic-sec} breaking changes]
8.3
release notes asciidoc file. For this release, ensure the include statement is:include::{security-repo-dir}/release-notes/8.3.asciidoc[tag=breaking-changes]
8.3
release notes asciidoc file. Here's what the section should look like:Notes:
breaking.asciidoc
file after:8.3
release notes page is available on the public docsite. This means that, in order for the8.3
Stack docs PR to be successfully built, BOTH of the following requirements need to be met:8.3
Security release notes PR merged into main and backported to the8.3
branch.8.3
Security release notes page will need to be built/published on the8.3
branchand available on the public docsite.The text was updated successfully, but these errors were encountered: