How to Publish a Brick to BrickHub

Updated

BrickHub is the official registry for publishing, discovering, and consuming reusable brick templates, so it is the place to publish a brick if you want others to install it with mason make. The site's own call to action is "Discover, publish, and install reusable templates called bricks to supercharge your workflow," and it pairs that with a "Request Access" link. That link is the key constraint: publishing access appears to be gated, so the first step is requesting access rather than assuming you can upload immediately. The exact upload flow is not described on the landing page, so treat the official docs as the source of truth for the current steps.

What you need before publishing

  • A working brick template that you have already generated locally with Mason, so you know it produces consistent output.
  • A clear, reusable purpose. BrickHub is a registry for reusable templates, not one-off scaffolding.
  • Access to the publishing side of BrickHub, which the site signals through "Request Access."

The publishing path

  1. Build and test the brick locally. Run it with mason make (the site's own example is mason make hello) and confirm the generated files are what you expect. A brick that only works on your machine is not ready to publish.
  2. Request access. Use the "Request Access" link on BrickHub. This is the step the page explicitly surfaces, and it is the gate between having a brick and being able to publish it.
  3. Follow the official docs for the upload itself. The landing page points to "Read the Docs" but does not spell out the publish commands or form. Use those docs for the current, authoritative procedure instead of guessing at menu locations.

Common sticking points

  • Assuming publishing is open. The presence of "Request Access" suggests it is not automatic. Plan for a wait or an approval step.
  • Publishing an untested brick. Because the registry is about consistent code generation, a brick that fails on a fresh project will not serve its purpose.
  • Skipping the docs. The landing page gives the concept and the entry points, not the mechanics. The docs are where the actual publish steps live.

What to verify once you publish

Confirm that your brick is discoverable through BrickHub's search and that a fresh mason make against it produces the same output you tested locally. That closes the loop between "published" and "usable by someone else."