Skip to content

Commit

Permalink
docs: update release doc around documentation PR (#14694)
Browse files Browse the repository at this point in the history
  • Loading branch information
kruskall authored Nov 20, 2024
1 parent ef9b5ad commit c12642b
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion dev_docs/RELEASES.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ For patch releases, only the version on the existing major and minor version bra
* Review the [changelogs/head](https://github.com/elastic/apm-server/tree/main/changelogs/head.asciidoc) file and move relevant changelog entries from `head.asciidoc` to `release_version.asciidoc` if the change is backported to release_version. If changes do not apply to the version being released, keep them in the `head.asciidoc` file.
* Review the commits in the release to ensure all changes are reflected in the release notes. Check for backported changes without release notes in `release_version.asciidoc`.
* Add your PR to the documentation release issue ([Sample Issue](https://github.com/elastic/dev/issues/2485)).
* The PR should only be merged on release day.
* The PR should be merged the day before release.
* For **minor releases**: run the [`run-minor-release`](https://github.com/elastic/apm-server/actions/workflows/run-minor-release.yml) workflow (In "Use workflow from", select `main` branch. Then in "The version", specify the minor release version the release is for).
This workflow will: create the release branch; update the changelog for the release branch and open a PR targeting the release branch titled `<major>.<minor>: update docs`; create a PR on `main` titled `<major>.<minor>: update docs, mergify, versions and changelogs`. Before merging them compare commits between latest minor and the new minor versions and ensure all relevant PRs have been included in the Changelog. If not, amend it in both PRs. Request and wait a PR review from the team before merging.
* The Release Manager will ping the team to align the release process
Expand Down

0 comments on commit c12642b

Please sign in to comment.