RELEASES.md

APM Server release checklist

Before the release

• Backport all relevant commits

• Create a PR that:

  1. Uncomments out relevant release notes. Release notes are in the changelogs.
  2. Updates the :stack-version:
  • Sample PR

• Create a separate PR to update vendor/github.com/elastic/beats/libbeat/version/version.go

  • Sample PR

• The following may also need to be updated manually:

  • APM Overview's release highlights - Anything exciting across the APM stack!
  • APM Overview's breaking changes - Any breaking changes across the APM stack.
  • APM Server's breaking changes - Any APM Server breaking changes.
  • APM Server's upgrade guide.

• Changelogs:

  • Review the changelogs to ensure all relevant notes have been added
  • 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 "VERSIONS" to include a new branch if necessary.

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.

When compatibility between Agents & Server changes

1. Update the agent/server compatibility matrix.

2. Update the version in APM Server's /docs/version.asciidoc. This ensures cross document links point to the correct documentation version.

3. Ensure the agent points to the correct server version by changing the :branch: attribute.

   • Example: Node 1.x vs. Node Master

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]
==== Added

[float]
==== Removed

[float]
==== Bug fixes
////

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...