- Overview
- Creating a Blueprint to Publish
- Creating a Blueprint
- Creating a Blueprint in the Page Editor
- Sharing as a Blueprint in the Extension Console
- Blueprint Configuration Fields
- Exposing Activation-Time Blueprint Options
- Integration Configurations
- Custom Options
- Sharing a Blueprint Publicly
- Sharing a Blueprint in the PixieBrix Marketplace
- Updating a Published Blueprint
- Incrementing the Version Number
- Staging Blueprint Updates
Overview
You can share blueprints publicly and publish them in the Marketplace so other users can easily find and access it. This page describes how to create a blueprint, share it publicly, and create a marketplace listing.
In addition to the text, here’s a video walk through:
Creating a Blueprint to Publish
Creating a Blueprint
To publish an action or enhancements, it needs to be part of a blueprint. A blueprint 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 blueprint:
- From the Page Editor
- From the Extension Console > Blueprints Screen
Creating a Blueprint in the Page Editor
Click the three dots button next to the Page Editor entry, and click Add to blueprint:
Sharing as a Blueprint in the Extension Console
In the Extension Console, navigate to the Blueprints screen.
Find the entry you want to share as a blueprint, click the three dots menu, and click Share
PixieBrix will prompt you to provide an id, name, version, and description
Blueprint Configuration Fields
When creating a blueprint, PixieBrix prompts you for the following information
- ID: a unique identified for the blueprint. 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 blueprint
- Version: a version number, in the format
major.minor.patch. For example: 1.0.0 - Description: a helpful description that describes what the blueprint is for
@username/slack/send-slack-message instead of @username/send-slack-messageExposing Activation-Time Blueprint Options
Integration Configurations
If you’ve added bricks that require integrations to the blueprint, those integration will show up in the Blueprint Activation Wizard automatically.
Custom Options
If you have non-integration onboarding options you want to add, you can add them by selecting the blueprint in the Page Editor and selecting the Blueprint Options 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 blueprint. For example, if the name is
fieldName, the field would be available in the blueprint as@options.fieldName - Label: the human-readable label to display in the Blueprint 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 Blueprint Publicly
When you’re ready to publish, go to the blueprints page, click Share on the blueprint.
PixieBrix will show a Share with Teams modal. To make the blueprint publicly available, toggle the Public toggle ON.
The activation link at the bottom can be used to share the blueprint with others who will be able to activate it once you’ve made it public.
Sharing a Blueprint in the PixieBrix Marketplace
When you share a blueprint publicly (see above), the PixieBrix team is notified. The PixieBrix team will reach out to assist with creating a Marketplace Listing
Updating a Published Blueprint
Incrementing the Version Number
When updating a published blueprint, it’s best practice to increment the version number to indicate the kind of change made:
For example:
- 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 Blueprint Updates
When making major changes to a blueprint, it can be helpful to make a separate blueprint so you don’t break anything on the copy users have currently.
You can then copy changes from the updated blueprint to the live blueprint in the Workshop.