Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOCS] 8.3.0 Release Notes #1964

Closed
nastasha-solomon opened this issue May 4, 2022 · 1 comment · Fixed by #2030
Closed

[DOCS] 8.3.0 Release Notes #1964

nastasha-solomon opened this issue May 4, 2022 · 1 comment · Fixed by #2030

Comments

@nastasha-solomon
Copy link
Contributor

nastasha-solomon commented May 4, 2022

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

  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.3.0-rn.
  4. 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.
  5. Insert a cross reference to the 8.3 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.3 release notes to update the release note's TOC. The include should be: include::release-notes/8.3.asciidoc[]
  7. 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.
  8. 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:

  1. 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.
  2. 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]
  3. 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:

@nastasha-solomon
Copy link
Contributor Author

nastasha-solomon commented May 17, 2022

PRs that aren't being retrieved by the RN tool, but will need to be release-noted for 8.3:

cc: @benironside

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant