Skip to content

Latest commit

 

History

History
49 lines (30 loc) · 1.53 KB

README.md

File metadata and controls

49 lines (30 loc) · 1.53 KB
Raw

Backlight release action

This action releases a Design System from https://backlight.dev

Inputs

api-token

Required: yes

This is the API token you can generate on https://backlight.dev. To get/generate it, go to the settings of your organization, then look for the REST API Token option available in the integrations tab

We recommend you set it up as an action secret and use it as documented in the example section

repo-token

Required: only if your repository is private

This is the GitHub generated token for the action. It is automatically generated by GitHub, and can be provided just by specifying ${{ secrets.GITHUB_TOKEN }}.

http://backlight.dev needs it in order to be able to clone your repository if it is private

component-id

Required: yes

This is the ID of the Design System you want to release. It can easily be extracted from the URL that you are using when working on your Design System

For example, with https://backlight.dev/edit/m7rLPfVrjtzOj7LGio3o/story-layout/src/index.tsx, m7rLPfVrjtzOj7LGio3o will be your ID

version

Required: yes

This is the version you want to release. You can provide the version you want, either reading it from your package.json file or computing from tags - the choice is yours!

Example usage

uses: actions/[email protected]
with:
  api-token: ${{ secrets.DSD_API_TOKEN }}
  repo-token: ${{ secrets.GITHUB_TOKEN }}
  component-id: designSystemID
  version: ${{ env.PROJECT_VERSION }} # set manually, obtained from a tag or computed