Action Inputs

Reference for all available inputs in the Typper Figma Plugin Deploy action

Action Inputs

This page documents all available inputs for the Typper Figma Plugin Deploy action.

Required Inputs

plugin-id

plugin-id · string · required

The unique identifier of your Figma plugin. You can find this in your plugin’s settings or URL.

Example:

with:
  plugin-id: "1234567890"

team-id

team-id · string · required

The ID of the Figma team where your plugin is hosted. Found in your team’s URL.

Example:

with:
  team-id: "9876543210"

Optional Inputs

release-notes

release-notes · string

Release notes for this version of your plugin. Supports markdown formatting.

Example:

with:
  release-notes: |
    ## New Features
    - Added dark mode support
    - Improved performance

    ## Bug Fixes
    - Fixed layout issues

Environment Variables

These are required environment variables that should be set as GitHub Secrets:

FIGMA_EMAIL

FIGMA_EMAIL · string · required

The email address associated with your Figma account.

FIGMA_PASSWORD

FIGMA_PASSWORD · string · required

Your Figma account password.

FIGMA_TOTP_SECRET

FIGMA_TOTP_SECRET · string · required

The TOTP secret for two-factor authentication.

Usage Example

Here’s a complete example using all available inputs:

name: Deploy Figma Plugin
on:
  push:
    tags:
      - "v*"

jobs:
  deploy:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4

      - name: Deploy Figma Plugin
        uses: typper-io/figma-plugin-deploy@v1
        with:
          plugin-id: "1234567890"
          team-id: "9876543210"
          release-notes: |
            ## What's New
            - Feature 1
            - Feature 2

            ## Bug Fixes
            - Fix 1
            - Fix 2
        env:
          FIGMA_EMAIL: ${{ secrets.FIGMA_EMAIL }}
          FIGMA_PASSWORD: ${{ secrets.FIGMA_PASSWORD }}
          FIGMA_TOTP_SECRET: ${{ secrets.FIGMA_TOTP_SECRET }}

Best Practices

1. Plugin ID

   • Keep it in environment variables for different environments
   • Validate the ID before deployment

2. Team ID

   • Store in environment variables
   • Verify team access permissions

3. Release Notes

   • Use clear and concise descriptions
   • Follow a consistent format
   • Include relevant version numbers

Related

Environment Variables

Learn about environment variable configuration

Workflow Setup

See workflow configuration examples