Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: update RELEASE.md #12983

Merged
merged 10 commits into from
May 30, 2024
Merged

docs: update RELEASE.md #12983

Changes from 6 commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
067846a
remove reference to release notes
endorama Apr 17, 2024
8ff3ad1
Update release instructions including automation
endorama Apr 17, 2024
b86b39d
Update RELEASES.md
endorama May 2, 2024
636da21
Merge branch 'main' into endorama-patch-1
endorama May 2, 2024
49ae368
Merge branch 'main' into endorama-patch-1
endorama May 8, 2024
e1aa910
Apply suggestions from code review
endorama May 8, 2024
837bc9a
enhance docs for patch releases
endorama May 27, 2024
963ac7c
Apply suggestions from code review
endorama May 28, 2024
43a62fe
better link to previous test plans
endorama May 30, 2024
56ec18b
Merge branch 'main' into endorama-patch-1
endorama May 30, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 13 additions & 29 deletions dev_docs/RELEASES.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,34 +9,17 @@ For patch releases, only the version on the existing major and minor version bra

## Feature Freeze

* For patch releases, ensure all relevant backport PRs are merged.
We use backport labels on PRs and automation to ensure labels are set.
* For **patch releases**:
* ensure all relevant backport PRs are merged. We use backport labels on PRs and automation to ensure labels are set.

bmorelli25 marked this conversation as resolved.
Show resolved Hide resolved
* Update Changelog

* Review existing [changelogs/head](https://github.com/elastic/apm-server/tree/main/changelogs/head.asciidoc) to ensure all relevant notes have been added.
* Move changelog entries from _head_ to _release_version_:
* Minor version:
Create new changelog file from [changelogs/head.asciidoc](https://github.com/elastic/apm-server/blob/main/changelogs/head.asciidoc)
If changes should not be backported, keep them in the _changelogs/head.asciidoc_ file.
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)
* Patch version: Add a new section to existing release notes. ([Sample PR](https://github.com/elastic/apm-server/pull/8313/files))
* Add `@elastic/obs-docs` as a reviewer.

## Day after Feature Freeze

* For minor releases, cut a new release branch from `main` and update them.
* Release branch:
Update versions and ensure that the `BEATS_VERSION` in the Makefile is updated,
e.g. [#2803](https://github.com/elastic/apm-server/pull/2803/files).
Trigger a new beats update, once the beats branch is also created.
Remove the [changelogs/head.asciidoc](https://github.com/elastic/apm-server/blob/main/changelogs/head.asciidoc) file from the release branch.

* Main branch:
Update [.mergify.yml](https://github.com/elastic/apm-server/blob/main/.mergify.yml) with a new backport rule for the next version,
and update versions to next minor version, e.g. [#2804](https://github.com/elastic/apm-server/pull/2804).

The release manager will ping the teams, but you can already prepare this in advance on the 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.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Describe what patch release automation does. It does not include changelog changes. It updates some versions iirc.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For patch release notes we could add something like this:

  • For patch releases, release notes must be manually added:
    • Add a new section to the existing release notes file (Sample PR).
    • Review the changelogs/head file and move all relevant release notes from head.asciidoc to release_version.asciidoc. 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).

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I added the suggested changes to 837bc9a (#12983)

* For **minor releases**: run the [`run-minor-release`](https://github.com/elastic/apm-server/actions/workflows/run-minor-release.yml) workflow.
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

* Update dependencies

Expand All @@ -55,11 +38,12 @@ For patch releases, only the version on the existing major and minor version bra

* Test plan

Create a github issue for testing the release branch (follow the GitHub issue template for the test plan), It should contain:
* 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
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).
* 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.
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:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What about including a recent example?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are you referring to the link on line 41 or 43? This link brings you to the new issue view with the test-plan template selected (there is a separate PR for updating the test plan). On line 43 instead there is a link to a 8.3.0 test plan, which looks like what you would like to see updated?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd like an new link to a recent test plan issue, in addition to the existing link to the issue view with filtered with test-plan label

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was suggesting to add a link to an example like #12822. I find it easier to see an actual example.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated in 43a62fe (#12983)

* A link to all PRs in the APM Server repository that need to be tested manually. Use the `test-plan` label and the version label (create it if it does not exist).
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).
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.
Any non-functional change or any change that is already covered by automated tests must not be included.
* 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.

## Between feature freeze and release

Expand Down