-
Notifications
You must be signed in to change notification settings - Fork 19
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.
-
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. -
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. -
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
-
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
Getting Started
- Home
- Module development 101
- Git crashcourse
- Upgrading a module built for Companion 2.x
- Companion module library versioning
- Releasing your module
Development
- File Structure
- manifest.json
- Logging
- Module debugging
- Module packaging
- Actions
- Feedbacks
- Presets
- Input Field Types
- Module configuration
- Upgrade scripts
- Variables
- HTTP Handler
Code quality
Advanced functionality