Pipelines automatically watch for events in the design system, run a specified exporter, and deliver the resulting code to your destination.
How pipelines work
- Select the exporter you would like to run.
- Configure an automatic observer that watches for events in the design system. Every time the specific event happens inside the design system, your exporter runs.
- Set a delivery destination for the generated code. Once the exporter finishes, the exported code is delivered to your destination automatically.
For detailed information on code delivery, please refer to Automation in the developer documentation.
Create a pipeline
- Navigate to Code automation -> Pipelines.
- Click the New pipeline button.
- Follow the steps below to create your pipeline.
1. Select an exporter
Exporters are packages (similar to an npm package, for example) that transform design system data into production code. Each exporter package is unique to which platform, technology or stack it targets, and in the code it produces.
Select an exporter from our exporter list to use in your pipeline. You can also build your own exporter — learn more in our developer documentation.
- Enter a name for your pipeline in the Name field.
- Select an exporter from the Exporter dropdown.
- Choose which brand and theme you want to use the pipeline for in their respective dropdowns.
- Click Next -> to move to the Event screen.
2. Select an event
Choose the event that will trigger your pipeline to run. You can learn more about each event in Event types.
3. Delivery
You'll finally need to select the delivery destination for the generated code. You can choose to open a pull request in whatever platform you prefer, or choose to only build the code without delivering it to any repository.
You can learn more about pull requests here.
If you select Build only, your resulting code will be available for download from the Pipelines table.