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 1 commit
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
8 changes: 7 additions & 1 deletion dev_docs/RELEASES.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,13 @@ 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.
This workflow will: create the release branch; update version across codebase; commit and create PR targetting release branch.
endorama marked this conversation as resolved.
Show resolved Hide resolved
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 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.
endorama marked this conversation as resolved.
Show resolved Hide resolved
* 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.
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