From ed1e7a435b6d6e2a97efc0b082e7b14aad45ebec Mon Sep 17 00:00:00 2001 From: Dave Abrahams Date: Wed, 12 Jun 2024 11:19:38 -0700 Subject: [PATCH 1/2] Document setup-vsdevenv dependency. --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index 93c9c9c..d0a2839 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,10 @@ Automates installation of the Swift toolchain for Windows hosts on GitHub Action ## Usage > **NOTE:** Only Swift 5.4.2+ is supported +> +> **NOTE:** This action requires a prior +> [compnerd/gha-setup-vsdevenv](https://github.com/compnerd/gha-setup-vsdevenv) step without +> which the proper `link.exe` might not be found by Swift's link step. * Sample workflow using official Swift releases @@ -16,6 +20,7 @@ jobs: windows: runs-on: windows-latest steps: + - uses: compnerd/gha-setup-vsdevenv@main - uses: compnerd/gha-setup-swift@main with: branch: swift-5.5-release @@ -35,6 +40,7 @@ jobs: windows: runs-on: windows-latest steps: + - uses: compnerd/gha-setup-vsdevenv@main - uses: compnerd/gha-setup-swift@main with: release-tag-name: "20230530.2" From da8d8b5688c7f410518c94dda67b8207cca74363 Mon Sep 17 00:00:00 2001 From: Dave Abrahams Date: Wed, 12 Jun 2024 12:36:09 -0700 Subject: [PATCH 2/2] Accuratize the note --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index d0a2839..0c17ab6 100644 --- a/README.md +++ b/README.md @@ -7,9 +7,11 @@ Automates installation of the Swift toolchain for Windows hosts on GitHub Action > **NOTE:** Only Swift 5.4.2+ is supported > -> **NOTE:** This action requires a prior -> [compnerd/gha-setup-vsdevenv](https://github.com/compnerd/gha-setup-vsdevenv) step without -> which the proper `link.exe` might not be found by Swift's link step. +> **NOTE:** This action may require a prior +> [compnerd/gha-setup-vsdevenv](https://github.com/compnerd/gha-setup-vsdevenv) step if +> your build requires the availability of tools from the MSVC toolset such as `link.exe`. +> The usual symptom of failure to add that step is a confusing message from the wrong +> `link.exe` executable. * Sample workflow using official Swift releases @@ -20,7 +22,6 @@ jobs: windows: runs-on: windows-latest steps: - - uses: compnerd/gha-setup-vsdevenv@main - uses: compnerd/gha-setup-swift@main with: branch: swift-5.5-release @@ -40,7 +41,6 @@ jobs: windows: runs-on: windows-latest steps: - - uses: compnerd/gha-setup-vsdevenv@main - uses: compnerd/gha-setup-swift@main with: release-tag-name: "20230530.2"