Skip to content

Releasing your module

Julian Waller edited this page Jun 30, 2025 · 3 revisions

The process for releasing your module is almost identical whether it is the first release or an update.

  1. Update the package.json version field to an appropriate increase.
    There is some guidance on the numbering here.
    By following this versioning scheme, it helps us know what is safe to include in patch releases of Companion, which can be done much more quickly than feature releases.

  2. Optionally, update the companion/manifest.json version field to the same number.
    We do not require this, the build process auto-populates this field and a few others for you.

  3. Create a tag/release with the same version number. This can be done either by:

    • On GitHub, in the release tab you can create a new release
    • Locally, you can create and push a git tag
  4. Submit the new version in the developer portal.

    • Look out for feedback on the change, some changes may be required before it can be included
Clone this wiki locally