docs: update RELEASE.md #12983
docs: update RELEASE.md #12983
Conversation
release notes are no more present in docs/release_notes.asciidoc
|
This pull request does not have a backport label. Could you fix it @endorama? 🙏
NOTE: |
mergify
bot
added
the
backport-skip
dev_docs/RELEASES.md
Outdated
| @@ -17,9 +17,9 @@ For patch releases, only the version on the existing major and minor version bra | |||
| * Review existing [changelogs/head](https://github.com/elastic/apm-server/tree/main/changelogs/head.asciidoc) to ensure all relevant notes have been added. | |||
There was a problem hiding this comment.
Question: how do I make sure there are no PR to be merged? I checked all PRs that don't have a backport-skip label applied through this search. If that is appropriate I would add it to the documentation to help streamline this step.
Guide the release manager to leverage available automations instead of performing manual actions.
| 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: |
There was a problem hiding this comment.
What about including a recent example?
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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
There was a problem hiding this comment.
I was suggesting to add a link to an example like #12822. I find it easier to see an actual example.
There was a problem hiding this comment.
Updated in 43a62fe (#12983)
Co-authored-by: Carson Ip <[email protected]>
|
@carsonip thanks for pointing to the doc release. I'll dig into that. |
dev_docs/RELEASES.md
Outdated
|
|
||
| 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. |
There was a problem hiding this comment.
Describe what patch release automation does. It does not include changelog changes. It updates some versions iirc.
There was a problem hiding this comment.
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.asciidoctorelease_version.asciidoc. If changes do not apply to the version being released, keep them in thehead.asciidocfile. - 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).
There was a problem hiding this comment.
I added the suggested changes to 837bc9a (#12983)
Co-authored-by: Carson Ip <[email protected]>
This PR aims at refreshing the release documentation for
apm-server. I'll use it to collect changes as I go through the release process as release manager.Closes #12864