Skip to content

Commit

Permalink
Update RELEASES.md (#13339)
Browse files Browse the repository at this point in the history
* Update RELEASES.md

specify which branch and version to use when running `run-*-release` GitHub workflows

Small improvement over what version is expected in The version field of run-patch-release workflow

---------

Co-authored-by: Carson Ip <[email protected]>
  • Loading branch information
endorama and carsonip authored Jul 1, 2024
1 parent caa5263 commit 96a3f1a
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions dev_docs/RELEASES.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,14 +16,14 @@ For patch releases, only the version on the existing major and minor version bra
## Day after Feature Freeze

* Trigger release workflow manually
* For **patch releases**: run the [`run-patch-release`](https://github.com/elastic/apm-server/actions/workflows/run-patch-release.yml) workflow.
* For **patch releases**: run the [`run-patch-release`](https://github.com/elastic/apm-server/actions/workflows/run-patch-release.yml) workflow (In "Use workflow from", select `main` branch. Then in "The version", specify the **next** patch release version - es: on `8.14.2` feature freeze you will use `8.14.3`).
This workflow will: create the release branch; update version across codebase; commit and create PR targeting the release branch.
Release notes for patch releases must be manually added:
Release notes for patch releases **must be manually added**:
* Add a new section to the existing release notes file ([Sample PR](https://github.com/elastic/apm-server/pull/12680)).
* 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.
* Add your PR to the documentation release issue ([Sample Issue](https://github.com/elastic/dev/issues/2485)).
* For **minor releases**: run the [`run-minor-release`](https://github.com/elastic/apm-server/actions/workflows/run-minor-release.yml) workflow.
* 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 Expand Up @@ -71,7 +71,7 @@ For patch releases, only the version on the existing major and minor version bra

* A new [tag](https://github.com/elastic/apm-server/releases) will automatically be created on GitHub.

* Bump the version in anticipation of the next release, e.g. [after 7.5.1 release](https://github.com/elastic/apm-server/pull/3045/files) bump to 7.5.2. Prepare this PR ahead of time, but only merge after release when pinged by the release manager.
* Bump the version in anticipation of the next release, e.g. [after 8.13.3 release](https://github.com/elastic/apm-server/pull/13066) bump to 8.13.4. **Prepare this PR ahead of time** but only merge it once pinged by the Release Manager on release date.

## When compatibility between Agents & Server changes

Expand Down

0 comments on commit 96a3f1a

Please sign in to comment.