You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* remove reference to release notes
release notes are no more present in docs/release_notes.asciidoc
* Update release instructions including automation
Guide the release manager to leverage available automations instead of performing manual actions.
* enhance docs for patch releases
* better link to previous test plans
---------
Co-authored-by: Carson Ip <[email protected]>
Copy file name to clipboardExpand all lines: dev_docs/RELEASES.md
+20-29Lines changed: 20 additions & 29 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,34 +9,23 @@ For patch releases, only the version on the existing major and minor version bra
9
9
10
10
## Feature Freeze
11
11
12
-
* For patch releases, ensure all relevant backport PRs are merged.
13
-
We use backport labels on PRs and automation to ensure labels are set.
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
14
15
-
* Update Changelog
16
-
17
-
* Review existing [changelogs/head](https://github.com/elastic/apm-server/tree/main/changelogs/head.asciidoc) to ensure all relevant notes have been added.
18
-
* Move changelog entries from _head_ to _release_version_:
19
-
* Minor version:
20
-
Create new changelog file from [changelogs/head.asciidoc](https://github.com/elastic/apm-server/blob/main/changelogs/head.asciidoc)
21
-
If changes should not be backported, keep them in the _changelogs/head.asciidoc_ file.
22
-
Don't forget to `include` and link to the new file in [main changelog](https://github.com/elastic/apm-server/blob/main/CHANGELOG.asciidoc) and the [release notes](https://github.com/elastic/apm-server/blob/main/docs/release-notes.asciidoc) file. [(Sample PR)](https://github.com/elastic/apm-server/pull/7956/files)
23
-
* Patch version: Add a new section to existing release notes. ([Sample PR](https://github.com/elastic/apm-server/pull/8313/files))
24
-
* Add `@elastic/obs-docs` as a reviewer.
25
15
26
16
## Day after Feature Freeze
27
17
28
-
* For minor releases, cut a new release branch from `main` and update them.
29
-
* Release branch:
30
-
Update versions and ensure that the `BEATS_VERSION` in the Makefile is updated,
31
-
e.g. [#2803](https://github.com/elastic/apm-server/pull/2803/files).
32
-
Trigger a new beats update, once the beats branch is also created.
33
-
Remove the [changelogs/head.asciidoc](https://github.com/elastic/apm-server/blob/main/changelogs/head.asciidoc) file from the release branch.
34
-
35
-
* Main branch:
36
-
Update [.mergify.yml](https://github.com/elastic/apm-server/blob/main/.mergify.yml) with a new backport rule for the next version,
37
-
and update versions to next minor version, e.g. [#2804](https://github.com/elastic/apm-server/pull/2804).
38
-
39
-
The release manager will ping the teams, but you can already prepare this in advance on the day after Feature Freeze.
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.
20
+
This workflow will: create the release branch; update version across codebase; commit and create PR targeting the release branch.
21
+
Release notes for patch releases must be manually added:
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.
25
+
* Add your PR to the documentation release issue ([Sample Issue](https://github.com/elastic/dev/issues/2485)).
26
+
* For **minor releases**: run the [`run-minor-release`](https://github.com/elastic/apm-server/actions/workflows/run-minor-release.yml) workflow.
27
+
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.
28
+
* The Release Manager will ping the team to align the release process
40
29
41
30
* Update dependencies
42
31
@@ -55,11 +44,13 @@ For patch releases, only the version on the existing major and minor version bra
55
44
56
45
* Test plan
57
46
58
-
Create a github issue for testing the release branch (follow the GitHub issue template for the test plan), It should contain:
59
-
* A link to all PRs in the APM Server repository that need to be tested manually. Use the `test-plan*` labels and the version labels
60
-
to create an overview over the PRs that need testing. For example, [test plan link for 8.3.0](https://github.com/elastic/apm-server/issues?q=label%3Atest-plan+is%3Aclosed+label%3Av8.3.0).
61
-
* Add other test cases that require manual testing, such as test scenarios on ESS, that are not covered by automated tests or
62
-
OS compatibility smoke tests for supporting new operating systems.
47
+
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:
48
+
* 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.
49
+
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)
50
+
and here you can find [all previous test plans](https://github.com/elastic/apm-server/issues?q=label%3Atest-plan+is%3Aclosed).
51
+
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.
52
+
Any non-functional change or any change that is already covered by automated tests must not be included.
53
+
* 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.
0 commit comments