https://github.com/divriots/action-dsd-release
Github Action for releasing DSD-made Design Systems
https://github.com/divriots/action-dsd-release
Last synced: 2 months ago
JSON representation
Github Action for releasing DSD-made Design Systems
- Host: GitHub
- URL: https://github.com/divriots/action-dsd-release
- Owner: divriots
- License: apache-2.0
- Created: 2021-04-19T21:28:12.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2022-11-14T15:50:45.000Z (over 3 years ago)
- Last Synced: 2025-03-01T14:16:51.353Z (over 1 year ago)
- Language: TypeScript
- Size: 178 KB
- Stars: 1
- Watchers: 5
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 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/action-dsd-release@v0.0.3
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
```