Skip to content

Commit 816321c

Browse files
committed
doc: add subtitles for different release types
1 parent 8270e0a commit 816321c

File tree

1 file changed

+54
-47
lines changed

1 file changed

+54
-47
lines changed

dev_docs/RELEASES.md

Lines changed: 54 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -9,53 +9,60 @@ For patch releases, only the version on the existing major and minor version bra
99

1010
## Feature Freeze
1111

12-
* For **patch releases**:
13-
* ensure all relevant backport PRs are merged. We use backport labels on PRs and automation to ensure labels are set.
14-
15-
16-
## Day after Feature Freeze
17-
18-
* Trigger release workflow manually
19-
* 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 **upcoming** patch release version - es: on `8.14.2` feature freeze you will use `8.14.2`).
20-
This workflow will: create the `update-<VERSION>` branch, update version constants across the codebase and create a PR targeting the release branch.
21-
Release notes for patch releases **must be manually added** at least one day before release.
22-
Create a PR targeting the `main` branch and add the backport label for the release branch.
23-
To add release notes:
24-
* Add a new section to the existing release notes file ([Sample PR](https://github.com/elastic/apm-server/pull/12680)).
25-
* 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.
26-
* 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`.
27-
* Add your PR to the documentation release issue in the [`elastic/dev`](https://github.com/elastic/dev/issues?q=is%3Aissue%20state%3Aopen%20label%3Adocs) repo ([Sample Issue](https://github.com/elastic/dev/issues/2485)).
28-
* The PR should be merged the day before release.
29-
* 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).
30-
This workflow will: create a new release branch using the stack version (X.Y); 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. After it's merged add your PR to the documentation release issue in the [`elastic/dev`](https://github.com/elastic/dev/issues?q=is%3Aissue%20state%3Aopen%20label%3Adocs) repo ([Sample Issue](https://github.com/elastic/dev/issues/2895)).
31-
* For **major releases**: run the [`run-major-release`](https://github.com/elastic/apm-server/actions/workflows/run-major-release.yml) workflow (In "Use workflow from", select `main` branch. Then in "The version", specify the major release version the release is for).
32-
This workflow will: create a new release branch using the stack version (X.Y); 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>.0: update docs, mergify, versions and changelogs`. Before merging them compare commits between latest minor and the new major 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. After it's merged add your PR to the documentation release issue in the [`elastic/dev`](https://github.com/elastic/dev/issues?q=is%3Aissue%20state%3Aopen%20label%3Adocs) repo ([Sample Issue](https://github.com/elastic/dev/issues/2895)).
33-
* The Release Manager will ping the team to align the release process
34-
35-
* Update dependencies
36-
37-
* libbeat:
38-
Updates are automatically created for the release branch, multiple times per week.
39-
If there is a need for a manual update, you can run `make update-beats` on the release branch.
40-
This might be the case when waiting for an urgent bug fix from beats, or after branching out the release branch.
41-
42-
For patch releases, the updates are supposed to only contain bug fixes. Take a quick look at the libbeat changes
43-
and raise it with the APM Server team if any larger features or changes are introduced.
44-
45-
* [go-elasticsearch](https://github.com/elastic/go-elasticsearch):
46-
If no branch or tag is available, ping the go-elasticsearch team.
47-
48-
`go get github.com/elastic/go-elasticsearch/v$major@$major.$minor`
49-
50-
* Test plan
51-
52-
Create a github issue for testing the release branch ([use the GitHub issue `test plan` template](https://github.com/elastic/apm-server/issues/new?assignees=&labels=test-plan&projects=&template=test-plan.md)), It should contain:
53-
* A link to all PRs in the APM Server repository that need to be tested manually to create an overview over the PRs that need testing.
54-
Use the `test-plan` label and the version label (create it if it does not exist). For example, [this was 8.13.0 test plan](https://github.com/elastic/apm-server/issues/12822)
55-
and here you can find [all previous test plans](https://github.com/elastic/apm-server/issues?q=label%3Atest-plan+is%3Aclosed).
56-
What we aim for is testing all functional changes applied to the new version. Review any PR updating `elastic/go-docappender` and `elastic/apm-data` dependencies, as some functional changes happens through these dependencies.
57-
Any non-functional change or any change already covered by automated tests must not be included.
58-
* Add other test cases that require manual testing, such as test scenarios on ESS, that are not covered by automated tests or OS compatibility smoke tests for supporting new operating systems.
12+
All release workflows (patch, minor, major) has to be triggered manually. The Release Manager will ping the team to align the release process.
13+
14+
### Patch Releases
15+
16+
- Ensure all relevant backport PRs are merged. We use backport labels on PRs and automation to ensure labels are set.
17+
- 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`). This workflow will:
18+
- Create the `update-<VERSION>` branch.
19+
- Update version constants across the codebase and create a PR targeting the release branch.
20+
- Release notes for patch releases **must be manually added** at least one day before release.
21+
- Create a PR targeting the `main` branch and add the backport label for the release branch. To add release notes:
22+
- Add a new section to the existing release notes file ([Sample PR](https://github.com/elastic/apm-server/pull/12680)).
23+
- 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.
24+
- 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`.
25+
- Add your PR to the documentation release issue in the [`elastic/dev`](https://github.com/elastic/dev/issues?q=is%3Aissue%20state%3Aopen%20label%3Adocs) repo ([Sample Issue](https://github.com/elastic/dev/issues/2485)).
26+
- The PR should be merged the day before release.
27+
28+
### Minor Releases
29+
30+
- 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:
31+
- Create a new release branch using the stack version (X.Y).
32+
- Update the changelog for the release branch and open a PR targeting the release branch titled `<major>.<minor>: update docs`.
33+
- Create a PR on `main` titled `<major>.<minor>: update docs, mergify, versions and changelogs`.
34+
35+
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. After it's merged add your PR to the documentation release issue in the [`elastic/dev`](https://github.com/elastic/dev/issues?q=is%3Aissue%20state%3Aopen%20label%3Adocs) repo ([Sample Issue](https://github.com/elastic/dev/issues/2895)).
36+
37+
### Major Releases
38+
39+
- Run the [`run-major-release`](https://github.com/elastic/apm-server/actions/workflows/run-major-release.yml) workflow (In "Use workflow from", select `main` branch. Then in "The version", specify the major release version the release is for). This workflow will:
40+
- Create a new release branch using the stack version (X.Y).
41+
- Update the changelog for the release branch and open a PR targeting the release branch titled `<major>.<minor>: update docs`.
42+
- Create a PR on `main` titled `<major>.0: update docs, mergify, versions and changelogs`.
43+
44+
Before merging them compare commits between latest minor and the new major 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. After it's merged add your PR to the documentation release issue in the [`elastic/dev`](https://github.com/elastic/dev/issues?q=is%3Aissue%20state%3Aopen%20label%3Adocs) repo ([Sample Issue](https://github.com/elastic/dev/issues/2895)).
45+
46+
## Update Dependencies
47+
48+
- libbeat:
49+
- Updates are automatically created for the release branch, multiple times per week.
50+
- If there is a need for a manual update, you can run `make update-beats` on the release branch.
51+
- This might be the case when waiting for an urgent bug fix from beats, or after branching out the release branch.
52+
- For patch releases, the updates are supposed to only contain bug fixes. Take a quick look at the libbeat changes and raise it with the APM Server team if any larger features or changes are introduced.
53+
54+
- [go-elasticsearch](https://github.com/elastic/go-elasticsearch):
55+
- If no branch or tag is available, ping the go-elasticsearch team, `go get github.com/elastic/go-elasticsearch/v$major@$major.$minor`.
56+
57+
## Test plan
58+
59+
Create a github issue for testing the release branch ([use the GitHub issue `test plan` template](https://github.com/elastic/apm-server/issues/new?assignees=&labels=test-plan&projects=&template=test-plan.md)), It should contain:
60+
61+
- A link to all PRs in the APM Server repository that need to be tested manually to create an overview over the PRs that need testing.
62+
- Use the `test-plan` label and the version label (create it if it does not exist). For example, [this was 8.13.0 test plan](https://github.com/elastic/apm-server/issues/12822) and here you can find [all previous test plans](https://github.com/elastic/apm-server/issues?q=label%3Atest-plan+is%3Aclosed).
63+
- What we aim for is testing all functional changes applied to the new version. Review any PR updating `elastic/go-docappender` and `elastic/apm-data` dependencies, as some functional changes happens through these dependencies.
64+
- Any non-functional change or any change already covered by automated tests must not be included.
65+
- Add other test cases that require manual testing, such as test scenarios on ESS, that are not covered by automated tests or OS compatibility smoke tests for supporting new operating systems.
5966

6067
## Between feature freeze and release
6168

0 commit comments

Comments
 (0)