https://github.com/mikaelvesavuori/figmagic-action

Use Figmagic to retrieve tokens, graphics, and/or React components from a Figma document.
https://github.com/mikaelvesavuori/figmagic-action

design-system design-tokens figma figma-api figmagic tokens ux

Last synced: 25 days ago
JSON representation

Use Figmagic to retrieve tokens, graphics, and/or React components from a Figma document.

• Host: GitHub
• URL: https://github.com/mikaelvesavuori/figmagic-action
• Owner: mikaelvesavuori
• License: mit
• Created: 2021-09-19T15:56:32.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2021-09-20T05:20:10.000Z (about 3 years ago)
• Last Synced: 2024-09-17T00:10:21.145Z (about 2 months ago)
• Topics: design-system, design-tokens, figma, figma-api, figmagic, tokens, ux
• Language: Shell
• Homepage: https://github.com/marketplace/actions/figmagic
• Size: 6.84 KB
• Stars: 11
• Watchers: 1
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# Figmagic GitHub action

Use [Figmagic](https://github.com/mikaelvesavuori/figmagic) to retrieve tokens, graphics, and/or React components from a Figma document.

## Setup and usage

You need to set two secrets: `FIGMA_URL` and `FIGMA_TOKEN`. Read more in the [Figmagic documentation](https://github.com/mikaelvesavuori/figmagic#running-figmagic) about how to get them. Refer to [GitHub's documentation](https://docs.github.com/en/actions/reference/encrypted-secrets) for how to set them.

Figmagic will pick up desired configuration from your `figmagic.json` file, but if this file does not exist Figmagic will create ("init") a base configuration file to use.

## Required input and output arguments

### `figma-url`

Figma document URL (full path) or document ID.

### `figma-token`

Personal Figma API token.

## Optional input and output arguments

No optional inputs/outputs are provided.

## Secrets the action uses

This Action uses two secrets: `FIGMA_URL` and `FIGMA_TOKEN`, as described above.

## Environment variables the action uses

None.

## An example of how to use this action in a workflow

```yml

on: [push]

jobs:

  figmagic:

    runs-on: ubuntu-latest

    name: Use Figmagic

    steps:

      - uses: actions/checkout@v2

      - id: figmagic

        uses: mikaelvesavuori/[email protected]

        with:

          figma-url: ${{ secrets.FIGMA_URL }}

          figma-token: ${{ secrets.FIGMA_TOKEN }}

```