Skip to content

Latest commit

 

History

History
137 lines (90 loc) · 4.74 KB

RELEASES.md

File metadata and controls

137 lines (90 loc) · 4.74 KB
Raw

APM Server release checklist

Before the release

  • Backport all relevant commits

    e.g. start with following command to see which files differ that are not necessarily expected: git diff elastic/master --name-only | grep -v '^vendor/' | grep -v '^docs/' | grep -v '^_beats'

  • Update beats

    run make update-beats in the branch from which the new branch will be created before FF to recognize potential issues

  • Update Kibana Index Pattern

    If fields are not up-to-date, run make update && script/update_kibana_objects.py and create a PR.

  • Update Changelog

    • Review existing changelogs/head to ensure all relevant notes have been added

    • Move changelogs from head to release_version:

      • Minor version: Create new changelog file from changelogs/head.asciidoc If changes should not be backported, keep them in the changelogs/head.asciidoc file.
      • Patch version: Add new section to existing release notes. (Sample PR)

      Create PR in master and backport.

    • Run the check_changelogs.py script to ensure changelogs are synced across branches. This will soon be a PR check.

    • Don't forget to update the "SUPPORTED_VERSIONS" to include a new branch if necessary.

  • For minor releases create a new release branch and

    • update versions in release branch, e.g. #2803
    • update versions in major.x branch to next minor version, e.g. #2804

  • Update to latest changes of beats

    When beats has merged all PRs and for minor releases created the new branch, update beats again.

  • Ensure a branch or tag is created for the go-elasticsearch library and update to it.

  • The following may also need to be updated manually:

  • For major releases, update and smoke test the dev quick start docker-compose.yml.

On release day

  • New branches need to be added to conf.yml in the elastic/docs repo. Example. This is handled by the docs release manager.

  • Merge the above PRs

  • Verify that a new tag has been created on GitHub.

  • Bump the version in anticipation of the next release, e.g. after 7.5.1 release bump to 7.5.2

    Prepare this PR ahead of time, but only merge after release!

When compatibility between Agents & Server changes

Templates

Templates for adding release notes, breaking changes, and highlights.

/changelogs/*.asciidoc template 
[[release-notes-7.1]]
== APM Server version 7.1

https://github.com/elastic/apm-server/compare/7.0\...7.1[View commits]

* <<release-notes-7.1.0>>

[[release-notes-7.1.0]]
=== APM Server version 7.1.0

https://github.com/elastic/apm-server/compare/v7.0.1\...v7.1.0[View commits]

No significant changes.
////
[float]
==== Breaking Changes

[float]
==== Bug fixes

[float]
==== Intake API Changes

[float]
==== Added
////
apm-release-notes.asciidoc template 
* <<release-highlights-7.1.0>>

[[release-highlights-7.1.0]]
=== APM version 7.1.0

No new features
////
[float]
==== New features

* Feature name and explanation...
////
apm-breaking-changes.asciidoc template 
* <<breaking-7.0.0, APM version 7.0.0>>

[[breaking-7.0.0]]
=== Breaking changes in 7.0.0

APM Server::
+
[[slug]]
**Title** Topic...

APM UI::
+
[[slug]]
**Title** Topic...