Skip to the content
Documentation
Help Start
Reading in:
  • German: 9,090 of 9,090 pages
About the help in other languages
All help pages

Announcing a release

Tell the people who use your extension about a release - the GitHub release itself, share.exponential.earth, the project page on projects.exponential.earth, ezpedia - what to write, and what to leave out.

Download as PDF

Address: https://doc.exponential.earth/exphelp/viewer/help/extension-development/part-7-releasing/announcing-a-release.md

On this page

Announcing a release

Part 7, chapter 12. A release nobody hears about helps nobody. Most users of an extension learn about updates from composer outdated or from a notification. Some need to be told, and new users need to find the extension. This chapter covers where to announce and what to say.

Where

PlaceReachesWhat to post
The GitHub releaseeveryone who watches the repositorythe release notes (GitHub releases and release notes)
share.exponential.earththe community: its forums include one for extensionsa short post for releases that matter: a new extension, a major version, a security fix
projects.exponential.earthpeople browsing the directory of community projectskeep the extension's project page current (version, links); see projects.exponential.earth
ezpedia.exponential.earthreaders of the knowledge basean article when the release brings a technique worth explaining

Not every patch release needs a post. A new extension, a new major version and every security release do.

What to write

A post is the release notes for people who do not know the extension yet:

  1. One sentence on what the extension does.
  2. What is new, in two to five lines, as users see it.
  3. Who should update, and how urgently. "Everyone on PHP 8.5" or "Only if you use the newsletter import".
  4. How to get it: the composer require line and the link to the release.
  5. Thanks to contributors, by their public names or accounts, if they want to be named.

Security releases

For a release that fixes a vulnerability:

  • Publish the fix first, then announce. Never describe the problem before users can update.
  • Say clearly that it is a security release, which versions are affected, and what users must do.
  • Describe the risk in general terms; do not publish an exploit.
  • Credit the person who reported it, if they agree (The maintainer path).

What not to post

  • Private information: customers, internal host names, unreleased plans of other people.
  • Promises of dates you do not control.
  • The same post in every channel at once: one main post, links elsewhere.

Become an Exponential Partner

Partners share their information, provide funding, contribute back and develop the products with us, and that is how Exponential grows. A partner website and dashboard are planned for mid-2027: please become a partner today to speed up our growth rate and land new features faster.

Something wrong on this page? Report an error

Documentation license

This documentation is free documentation, licensed under the GNU Free Documentation License 1.3 or later.

Exponential Copyright © 1998-2026 Exponential Foundation and 7x