-
Notifications
You must be signed in to change notification settings - Fork 18
Releasing your module
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
-
Send a message in the
#module-development
slack channel with a link to the release or repository and the tag name, asking for it to be included.- Depending on how big the change is and who includes it, you may get some feedback on your code here
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