migueldomingues/markdown-figma-action

Markdown Figma GitHub Action

Initial Setup

After you've cloned the repository to your local machine or codespace, you'll need to perform some initial setup steps before you can develop your action.

1. 🛠️ Install the dependencies

   npm install

2. 🏗️ Package the JavaScript for distribution

   npm run bundle

3. ✅ Run the tests

   npm test

Update the Action Code

1. Create a new branch

   git checkout -b releases/v1

2. Update contents of src/

3. Add tests to __tests__/ for your source code

4. Format, test, and build the action

   npm run all

5. Commit your changes and push them to your repository

6. Create a pull request

7. Merge the pull request into the main branch

Usage

steps:
  - name: Checkout
    uses: actions/checkout@v4

  - name: Setup markdown-figma
    uses: MiguelDomingues/markdown-figma-action@v1

  - name: Run markdown-figma
    run: markdown-figma --help