setup-typst/action.yml at main · typst-community/setup-typst · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
name: Setup Typst
description: 📑 Install Typst and add it to the PATH with package management

branding:
  icon: terminal
  color: white

inputs:
  typst-version:
    description: "Version range or exact version of Typst to use, using SemVer's version range syntax. Uses the latest version if unset."
    default: latest
  allow-prereleases:
    description: "When 'true', a version range including 'latest' passed to 'typst-version' input will match prerelease versions."
    default: false
  executable-name:
    description: "Used to specify the executable file name of Typst."
    default: typst
  typst-versions-file:
    description: "Used to specify a path to a configuration file (JSON, HJSON, YAML, TOML, XML, INI, or HCL) mapping executable names to Typst version configurations, for installing multiple Typst versions at once. The format is detected automatically from the file extension."
    required: false
  typst-versions-json:
    description: "Used to specify a JSON map of executable names to Typst version configurations, for installing multiple Typst versions at once."
    required: false
  typst-versions-hjson:
    description: "Used to specify a HJSON map of executable names to Typst version configurations, for installing multiple Typst versions at once."
    required: false
  typst-versions-yaml:
    description: "Used to specify a YAML map of executable names to Typst version configurations, for installing multiple Typst versions at once."
    required: false
  typst-versions-toml:
    description: "Used to specify a TOML map of executable names to Typst version configurations, for installing multiple Typst versions at once."
    required: false
  typst-versions-xml:
    description: "Used to specify an XML document mapping executable names to Typst version configurations, for installing multiple Typst versions at once."
    required: false
  typst-versions-ini:
    description: "Used to specify an INI document mapping executable names to Typst version configurations, for installing multiple Typst versions at once."
    required: false
  typst-versions-hcl:
    description: "Used to specify an HCL document mapping executable names to Typst version configurations, for installing multiple Typst versions at once."
    required: false
  typst-versions-map:
    description: "[Deprecated] Used to specify a JSON map of executable names to Typst version configurations, for installing multiple Typst versions at once."
    required: false
  cache-dependency-path:
    description: "Used to specify the path to a Typst file containing lines of 'import' keyword."
    required: false
  zip-packages-file:
    description: "Used to specify a path to a configuration file (JSON, HJSON, YAML, TOML, XML, INI, or HCL) mapping package namespaces to required package information. The format is detected automatically from the file extension."
    required: false
  zip-packages-json:
    description: "Used to specify a JSON map of package namespaces to required package information."
    required: false
  zip-packages-hjson:
    description: "Used to specify a HJSON map of package namespaces to required package information."
    required: false
  zip-packages-yaml:
    description: "Used to specify a YAML map of package namespaces to required package information."
    required: false
  zip-packages-toml:
    description: "Used to specify a TOML map of package namespaces to required package information."
    required: false
  zip-packages-xml:
    description: "Used to specify an XML document mapping package namespaces to required package information."
    required: false
  zip-packages-ini:
    description: "Used to specify an INI document mapping package namespaces to required package information."
    required: false
  zip-packages-hcl:
    description: "Used to specify an HCL document mapping package namespaces to required package information."
    required: false
  zip-packages:
    description: "[Deprecated] Used to specify the path to a JSON file containing names and ZIP archive URLs of packages."
    required: false
  cache-local-packages:
    description: "When 'true', local packages set by 'zip-packages-*' will be cached independently of '@preview' packages."
    default: false
  token:
    description: "The token used to authenticate when fetching Typst distributions from typst/typst. When running this action on github.com, the default value is sufficient. When running on GHES, you can pass a personal access token for github.com if you are experiencing rate limiting."
    default: ${{ github.server_url == 'https://github.com' && github.token || '' }}

runs:
  using: node24
  main: dist/main/index.js