Skip to content
Use this GitHub action with your project
Add this Action to an existing workflow or create a new one
View on Marketplace

Repository files navigation

setup-zotero

Download and setup Zotero in CI for plugin development and testing.

Usage

jobs:
  test:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v7
      - uses: zotero-plugin-dev/setup-zotero@v1
        with:
          channel: release
      - run: echo "Zotero at ${{ steps.zotero.outputs.zotero-bin-path }}"

Inputs

Name Description Required Default
zotero-version Zotero version (e.g. 7.0.0, 7.1-beta.39+0acfcd3f9). Omit for latest. No
channel Release channel: release, beta, or dev No release
architecture Target platform. Auto-detected if omitted. One of: mac, win-x64, win-arm64, linux-x86_64, linux-i686 No
cache Use GitHub Actions cache No true

Outputs

Name Description
cache-hit Whether Zotero was restored from cache
zotero-version Installed Zotero version
zotero-bin-path Path to the Zotero executable
zotero-platform Resolved platform identifier
zotero-channel Resolved channel

Environment Variables

Variable Description
ZOTERO_BIN_PATH Path to Zotero executable
ZOTERO_PLUGIN_ZOTERO_BIN_PATH Same as ZOTERO_BIN_PATH (for zotero-plugin-scaffold)
ZOTERO_VERSION Installed Zotero version
ZOTERO_SETUP_COMPLETE Set to true when all setup is done (scaffold can skip init)

Platform Support

Platform Status
Windows (x64, arm64) Supported
macOS (universal) Supported
Linux (x86_64, i686) Supported, with automatic Xvfb setup

Caching

Installer and extracted program files are cached. Cache key format:

zotero-{platform}-{channel}-{version}

Set cache: 'false' to disable caching.

Releases

Packages

Contributors

Languages