- Creating a Mod to Publish
- Creating a Mod
- Creating a Mod in the Page Editor
- Sharing as a Mod in the Extension Console
- Mod Configuration Fields
- Exposing Activation-Time Mod Options
- Integration Configurations
- Custom Options
- Sharing a Mod Publicly
- Sharing a Mod in the PixieBrix Marketplace
- Updating a Published Mod
- Incrementing the Version Number
- Staging Mod Updates
You can share mods publicly and publish them in the Marketplace so other users can easily find and access it. This page describes how to create a mod, share it publicly, and create a marketplace listing.
In addition to the text, here’s a video walk-through:
Creating a Mod to Publish
Creating a Mod
To publish an action or enhancements, it needs to be part of a mod. A mod contains one or more actions/enhancements along with a description and activation options.
There are two ways to package an action or enhancement as a mod:
- From the Page Editor
- From the Extension Console > Mods Screen
Creating a Mod in the Page Editor
Click the three dots button next to the Page Editor entry, and click Add to mod:
Sharing as a Mod in the Extension Console
In the Extension Console, navigate to the Mods screen.
Find the entry you want to share as a mod, click the three dots menu, and click Share
PixieBrix will prompt you to provide an id, name, version, and description
Mod Configuration Fields
When creating a mod, PixieBrix prompts you for the following information
- ID: a unique identified for the mod. It must start with your author scope, or an author scope of a team where you have a Developer role.
- Name: a human-readable name for the mod
- Version: a version number, in the format
major.minor.patch. For example: 1.0.0
- Description: a helpful description that describes what the mod is for
Exposing Activation-Time Mod Options
If you’ve added bricks that require integrations to the mod, those integrations will show up in the Mod Activation Wizard automatically.
If you have non-integration onboarding options you want to add, you can add them by selecting the mod in the Page Editor and selecting the Input Form tab.
Similar to the Form Builder, you can add any number of options fields:
- Name: the field name for referencing the configured value in the mod. For example, if the name is
fieldName, the field would be available in the mod as
- Label: the human-readable label to display in the Mod Activation Wizard
To add a new field. Click the Add new field button:
To switch between fields to configure, click the field in the Preview in the Data Panel on the right side of the Page Editor.
Sharing a Mod Publicly
When you’re ready to publish, go to the mod page, click Share on the mod.
PixieBrix will show a Share with Teams modal. To make the mod publicly available, toggle the Public toggle ON.
The activation link at the bottom can be used to share the mod with others who will be able to activate it once you’ve made it public.
Sharing a Mod in the PixieBrix Marketplace
When you share a mod publicly (see above), the PixieBrix team is notified. The PixieBrix team will reach out to assist with creating a Marketplace Listing
Updating a Published Mod
Incrementing the Version Number
When updating a published mod, it’s best practice to increment the version number to indicate the kind of change made:
- Increment Patch version (for bug fixes): 1.2.3 → 1.2.4
- Increment Minor version (for new features): 1.2.3 → 1.3.0
- Increment Major version (for backward incompatible changes): 1.2.3 → 2.0.0
Incrementing the version number conveys two primary benefits:
- PixieBrix and users know it’s a new version
- You can track changes made across versions, and/or revert to a previous version
Staging Mod Updates
When making major changes to a mod, it can be helpful to make a separate mod so you don’t break anything on the copy users currently have.
You can then copy changes from the updated mod to the live mod in the Workshop.