Versioning
How extension versions are tracked, and why every extension needs a changelog.
Every extension carries a changelog, declared as part of its required folder structure.
The changelog is how installers learn what changed
An extension is installed by other people, often in more than one environment, and its settings are configured per installation. When behavior changes, the changelog is how an installer finds out.
For a public extension on the Marketplace, it's read by customers deciding whether an update is safe to take.
Record anything an installer has to act on
- a new or removed action
- a new required setting, which will break existing installations until configured
- a change in what an action returns, since care flows may store it as data points
- a fix that changes observable behavior
A new required setting is the one to be loudest about, since every existing installation needs attention.
This page is thinner than it should be. The source it came from is a placeholder, so the mechanics of how extension versions are numbered, published and pinned are not documented yet. Email support@awellhealth.com in the meantime.
Next steps
Next: Contributing guidelines for a public extension.