doc: improve dev_docs release instructions#20257
Open
inge4pres wants to merge 1 commit intoelastic:mainfrom
Open
doc: improve dev_docs release instructions#20257inge4pres wants to merge 1 commit intoelastic:mainfrom
inge4pres wants to merge 1 commit intoelastic:mainfrom
Conversation
Signed-off-by: inge4pres <francesco.gualazzi@elastic.co>
Contributor
🤖 GitHub commentsJust comment with:
|
Contributor
|
This pull request does not have a backport label. Could you fix it @inge4pres? 🙏
|
Contributor
|
We have a script for changelog automation https://github.com/elastic/apm-server/blob/main/tools/scripts/changelog.sh It should take care of updating the changelog for the new release. Can you add it to the process? I thought it was run as part of the GitHub workflow but it does not seems to be the case. |
carsonip
reviewed
Feb 3, 2026
| 1. Create a *Test Plan*. | ||
| 2. Ensure all relevant backport PRs are merged. We use backport labels on PRs and automation to ensure labels are set. | ||
| 3. Run the [`run-patch-release`](https://github.com/elastic/apm-server/actions/workflows/run-patch-release.yml) workflow | ||
| 1. [Compare](https://github.com/elastic/apm-server/compare/) the commits in the release branch against the last tag to ensure all changes are reflected in the release notes, e.g. when releasing `v9.2.5`, compare [v9.2.4 <- 9.2](https://github.com/elastic/apm-server/compare/v9.2.4..9.2) |
Member
There was a problem hiding this comment.
Suggested change
| 1. [Compare](https://github.com/elastic/apm-server/compare/) the commits in the release branch against the last tag to ensure all changes are reflected in the release notes, e.g. when releasing `v9.2.5`, compare [v9.2.4 <- 9.2](https://github.com/elastic/apm-server/compare/v9.2.4..9.2) | |
| 1. [Compare](https://github.com/elastic/apm-server/compare/) the commits in the release branch against the last tag to ensure all changes are reflected in the release notes, e.g. when releasing `v9.2.5`, compare [v9.2.4 <- 9.2](https://github.com/elastic/apm-server/compare/v9.2.4..9.2). Even better, if the release commit is already known, compare the release commit vs the previous release to avoid including commits that are merged but missed the last release build. |
| 1. [Compare](https://github.com/elastic/apm-server/compare/) the commits in the release branch against the last tag to ensure all changes are reflected in the release notes, e.g. when releasing `v9.2.5`, compare [v9.2.4 <- 9.2](https://github.com/elastic/apm-server/compare/v9.2.4..9.2) | ||
| 2. Create a *Test Plan*. Open a GitHub issue of type "Test Plan", go through the changes in libraries and fill in the issue template with a list of PRs that need to be tested. | ||
| 3. Ensure all relevant backport PRs are merged. We use backport labels on PRs and automation to ensure labels are set. | ||
| 4. Run the [`run-patch-release`](https://github.com/elastic/apm-server/actions/workflows/run-patch-release.yml) workflow |
Member
There was a problem hiding this comment.
This should be done on release day, when stack release RM pings the team to bump doc versions to "vX.Y.Z" then we input "X.Y.Z" to patch release workflow.
| 4. 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 **upcoming** patch release version - es: on `8.14.2` feature freeze you will use `8.14.2`). | ||
| - Then in "The version", specify the **upcoming** patch release version - e.g. on `9.2.5` feature freeze you will use `9.2.5`. |
Member
There was a problem hiding this comment.
not on FF but on previous patch release day.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Motivation/summary
The dev docs on the 9.x release process are wrong.
Related issues