Setup mermaid-cli for GitHub Actions

Setup mermaid-cli on GitHub Actions to use mmdc.

This action installs mermaid-cli for use in actions by installing it on tool cache using AnimMouse/tool-cache.

This action is implemented as a composite action.

This action currently only works on Ubuntu.

Usage

To use mmdc, run this action before mmdc.

steps:
  - name: Setup mermaid-cli
    uses: AnimMouse/setup-mermaid-cli@v1
    
  - run: mmdc -i input.mermaid -o output.png

This action automatically patches mmdc to run Puppeteer in --no-sandbox mode.

Specific version

You can specify the version you want. By default, this action downloads the latest version if the version is not specified.

steps:
  - name: Setup mermaid-cli
    uses: AnimMouse/setup-mermaid-cli@v1
    with:
      version: 11.4.0

GitHub token

This action automatically uses a GitHub token in order to authenticate with the GitHub API and avoid rate limiting. You can also specify your own read-only fine-grained personal access token.

steps:
  - name: Setup mermaid-cli
    uses: AnimMouse/setup-mermaid-cli@v1
    with:
      token: ${{ secrets.GH_PAT }}