Allow installing multiple Typst versions at once (#58)

yusancky · web-flow · commit 0bb64c69476d · 2026-03-15T11:27:46.000+08:00
resolve #53 ## Important Changes - Added a new input parameter: `typst-versions-map`, which allows installing multiple Typst versions at once. - Removed the following original outputs due to the support for multiple simultaneous Typst installations: - `typst-version`: The installed Typst version. Useful when given a version range as input. - `cache-hit`: A boolean value to indicate a cache entry was found.
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -80,6 +80,30 @@ jobs:
       - run: typst-latest compile test/basic/main.typ
       - run: typst-013 --version
       - run: typst-013 compile test/basic/main.typ
+  test-versions-map:
+    runs-on: ${{ matrix.os }}
+    needs: [build, test-basic]
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, macos-latest, windows-latest]
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/download-artifact@v4
+        with:
+          name: action-dist
+          path: ./dist
+      - uses: ./
+        with:
+          typst-versions-map: |
+            {
+              "typst-latest": {"version": "latest"},
+              "typst-013": {"version": "v0.13"}
+            }
+      - run: typst-latest --version
+      - run: typst-latest compile test/basic/main.typ
+      - run: typst-013 --version
+      - run: typst-013 compile test/basic/main.typ
   test-zip-packages:
     runs-on: ${{ matrix.os }}
     needs: [build, test-basic]
diff --git a/README.md b/README.md
@@ -34,10 +34,11 @@ jobs:
 
 ### Inputs
 
-#### Specifying Typst Versions
+#### Installing A Typst Version
 
 - **`typst-version`:** Version range or exact version of Typst to use, using SemVer's version range syntax. Uses the latest version if unset.
 - **`allow-prereleases`:** When `true`, a version range including `latest` passed to `typst-version` input will match prerelease versions.
+  **`executable-name`:** Used to specify the executable file name of Typst.
 
 ```yaml
 # Example 1
@@ -50,25 +51,41 @@ jobs:
   with:
     typst-version: 0.14.0-rc1
     allow-prereleases: true
-```
-
-#### Specifying Typst Executable File Name
 
-**`executable-name`:** Used to specify the executable file name of Typst.
-
-```yaml
+# Example 3
 - uses: typst-community/setup-typst@v4
   with:
     executable-name: typst-latest
-- run: typst-latest compile paper.typ paper.pdf
 ```
 
 > [!TIP]
 >
 > - `executable-name` defaults to `typst`.
 > - A Typst executable named `typst-${version}` is always kept.
 > - For Windows, there is no need to include the executable file extension `.exe` in the parameters.
-> - Multiple distinct `executable-name` values can be set for the same Typst version. Setting the same `executable-name` (including the default `typst`) for different Typst versions is **not recommended**, as it may lead to version management confusion.
+> - Multiple distinct `executable-name` values can be set for the same Typst version.
+> - Setting the same `executable-name` (including the default `typst`) for different Typst versions is **not recommended**, as it may lead to version management confusion.
+
+#### Installing Multiple Typst Versions
+
+**`typst-versions-map`:** Used to specify a JSON map of executable names to Typst version configurations, for installing multiple Typst versions at once. Each value is an object with a required `version` field and an optional `allowPrerelease` field.
+
+> [!NOTE]
+>
+> When `typst-versions-map` is set, `typst-version` and `executable-name` are **ignored**. The `allow-prereleases` input is used as the **default value** for all entries in the map, but can be **overridden** by `allowPrerelease` in each individual config object.
+
+```yaml
+- uses: typst-community/setup-typst@v4
+  with:
+    typst-versions-map: |
+      {
+        "typst-latest": {"version": "latest"},
+        "typst-013": {
+          "version": "v0.13",
+          "allowPrerelease": true
+        }
+      }
+```
 
 #### Managing Packages with Cache
 
@@ -121,11 +138,6 @@ jobs:
 
 **`token`:** 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.
 
-### Outputs
-
-- **`typst-version`:** The installed Typst version. Useful when given a version range as input.
-- **`cache-hit`:** A boolean value to indicate a cache entry was found.
-
 ### Integration with Other Actions
 
 #### Uploading Artifacts
diff --git a/README_zh-Hans-CN.md b/README_zh-Hans-CN.md
@@ -34,10 +34,11 @@ jobs:
 
 ### 输入
 
-#### 指定 Typst 版本
+#### 安装单个 Typst 版本
 
 - **`typst-version`:** 使用的 Typst 版本范围或确切版本，采用 SemVer 语义化版本范围语法。默认使用最新版本。
 - **`allow-prereleases`:** 当设置为 `true` 时，传递给 `typst-version` 的版本范围（包含 `latest`）将匹配预发布版本。
+  **`executable-name`:** 指定的 Typst 可执行文件的名称。
 
 ```yaml
 # Example 1
@@ -50,25 +51,41 @@ jobs:
   with:
     typst-version: 0.14.0-rc1
     allow-prereleases: true
-```
-
-#### 指定 Typst 可执行文件名
 
-**`executable-name`:** 指定的 Typst 可执行文件的名称。
-
-```yaml
+# Example 3
 - uses: typst-community/setup-typst@v4
   with:
-      executable-name: typst-latest
-      - run: typst-latest compile paper.typ paper.pdf
+    executable-name: typst-latest
 ```
 
 > [!TIP]
 >
 > - `executable-name` 默认为 `typst`。
 > - 一份名为 `typst-${version}` 的 Typst 可执行文件总是被保存。
 > - 对于 Windows，不需要在参数中设置可执行文件后缀名 `.exe`。
-> - 可以为同一版本 Typst 设置多个不同的 `executable-name`。**不推荐** 对不同版本 Typst 设置相同的 `executable-name`（包括默认的 `typst`），因为这可能导致版本管理混乱。
+> - 可以为同一版本 Typst 设置多个不同的 `executable-name`。
+> - **不推荐** 对不同版本 Typst 设置相同的 `executable-name`（包括默认的 `typst`），因为这可能导致版本管理混乱。
+
+#### 同时安装多个 Typst 版本
+
+**`typst-versions-map`:** 用于指定一个以可执行文件名为键、Typst 版本配置为值的 JSON 映射，以同时安装多个 Typst 版本。每个值是一个包含必填 `version` 字段和可选 `allowPrerelease` 字段的对象。
+
+> [!NOTE]
+>
+> 当 `typst-versions-map` 被设置时，`typst-version` 和 `executable-name` 将被**忽略**。`allow-prereleases` 输入将作为映射中所有条目的**默认值**，但可被各条目中的 `allowPrerelease` 字段**覆盖**。
+
+```yaml
+- uses: typst-community/setup-typst@v4
+  with:
+    typst-versions-map: |
+      {
+        "typst-latest": {"version": "latest"},
+        "typst-013": {
+          "version": "v0.13",
+          "allowPrerelease": true
+        }
+      }
+```
 
 #### 包管理与缓存
 
@@ -121,11 +138,6 @@ jobs:
 
 **`token`:** 当从 [typst/typst] 拉取版本时使用的 GitHub 令牌。当在 github.com 上运行操作时，使用默认值；当在 GitHub Enterprise Server（GHES）上运行，可以传递一个 github.com 的个人访问令牌规避速率限制问题。
 
-### 输出
-
-- **`typst-version`:** 安装的 Typst 的确切版本。在输入时给定版本范围时可能有用。
-- **`cache-hit`:** 一个表示是否找到 Typst 缓存的布尔值。
-
 ### 与其它操作组合使用
 
 #### 上传构件
diff --git a/action.yml b/action.yml
@@ -15,6 +15,9 @@ inputs:
   executable-name:
     description: "Used to specify the executable file name of Typst."
     default: typst
+  typst-versions-map:
+    description: "Used to specify a JSON map of executable names to Typst version configurations, for installing multiple Typst versions at once. Each value is an object with a required 'version' field and an optional 'allowPrerelease' field."
+    required: false
   cache-dependency-path:
     description: "Used to specify the path to a Typst file containing lines of 'import' keyword."
     required: false
@@ -31,12 +34,6 @@ inputs:
     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 || '' }}
 
-outputs:
-  typst-version:
-    description: "The installed Typst version. Useful when given a version range as input."
-  cache-hit:
-    description: "A boolean value to indicate a cache entry was found."
-
 runs:
   using: node20
   main: dist/main/index.js
diff --git a/src/main.ts b/src/main.ts
