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

8.9.2 Release notes #3801

Closed
1 task
nastasha-solomon opened this issue Aug 24, 2023 · 0 comments · Fixed by #3820
Closed
1 task

8.9.2 Release notes #3801

nastasha-solomon opened this issue Aug 24, 2023 · 0 comments · Fixed by #3820

Comments

@nastasha-solomon
Copy link
Contributor

Description

Generate the 8.9.2 release notes and publish them before or on the release day, which is August 29, 2023.

Milestone dates:

  • FF: August 29, 2023
  • BC: August 31, 2023
  • Release: September 5, 2023

Steps

  1. Create a new branch using GH Desktop or the CLI. Here are the steps for the CLI:
    a. From the CLI, run git checkout main to checkout the main branch.
    b. Run git fetch origin to retrieve the latest version of the main branch.
    c. Run git pull to pull down the latest changes in the main branch.
    d. Run git checkout -b issue-XXX-8.9.2-rn to create a new branch.
  2. Open the Security docs project in your text editor (VS Code).
  3. Expand the release-notes folder the open the 8.9.asciidoc file.
  4. At the top of the file, create a new section for the 8.9.2 release notes. Include the following sections: Bug fixes, breaking changes, and any other relevant sections.

Example:

[discrete]
[[release-notes-8.9.2]]
=== 8.9.2

[discrete]
[[breaking-changes-8.9.2]]
==== Breaking changes  

TBD.

//end::breaking-changes[]

[discrete]
[[enhancements-8.9.2]]
==== Enhancements
There are no user-facing changes in 8.9.2.

[discrete]
[[bug-fixes-8.9.2]]
==== Bug fixes 
* TBD
  1. Open the release-notes.asciidoc file and insert a link to the 8.9.2 release notes, for example: <<release-notes-v, {elastic-sec} version 8.9.2>>
  2. Save your changes.
  3. Commit and push your changes:
    a. Run git add --all to add changes from all tracked and untracked files.
    b. Run git commit -m "A brief description of your change" to commit your changes.
    c. Run git push to push your changes to the remote branch. If the branch doesn’t already exist in the remote repo, it is automatically created.
  4. Open a PR in GH. Remember to add the 8.9 label so the release notes changes are backported to the 8.9 branch after you merge them into main.

Notes:

  • @nastasha-solomon to check with @roxana-gheorghe if any Endpoint PRs need to be release-noted for 8.9.2.
  • If you add the PR to the Endpoint feature/bug/known issue, use the hardcoded URL to create the reference link. Here is an example.
  • ResponseOps features for cases, connectors, and alerts are always doc'd in the Kibana release notes unless they are Security-specific features. This is also the case for Osquery feature and enhancements.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Development

Successfully merging a pull request may close this issue.

1 participant