powershell - 当目标条目文件不在根目录中时，Azure DevOps 自定义构建任务扩展找不到 PowerShell VstsTaskSdk.psd1

Question

我构建了 Wait前段时间Azure DevOps构建/发布任务扩展，最近开始运行时报如下警告:

[warning]Task 'Wait' (1.2.3) is using deprecated task execution handler. The task should use the supported task-lib: https://aka.ms/tasklib

因此，按照该链接转到 Azure Pipelines Task SDK GitHub repo然后钻入 Consuming the PowerShell API SDK link看起来我需要在我的 task.json 文件中将我的扩展从旧的 PowerShell 执行处理程序更新到新的 PowerShell3 执行处理程序，所以我进行了更改，现在代码如下所示:

  "execution": {
    "PowerShell3": {
      "target": "$(currentDirectory)/Code/Wait.ps1",
      "workingDirectory": "$(currentDirectory)"
    }
  }

按照页面上的说明，我完成了 Save-Module -Name VstsTaskSdk -Path .\ 下载 SDK 模块并将其提交到 ps_modules\VstsTaskSdk 目录在我的扩展任务的根目录下。

但是，在 MS 托管代理上构建并运行扩展后，它给出了错误:

[error]File not found: 'D:\a_tasks\Wait_f3e9b3d7-a528-5245-91c7-453406bcb038\1.2.17\Code\ps_modules\VstsTaskSdk\VstsTaskSdk.psd1'

我注意到它正在寻找 Code 目录中的 ps_modules 目录，所以我尝试将它放在我的 git repo 中，但结果仍然相同错误。

我找到了 this very similar StackOverflow question ，但他们的解决方案是从他们的 ps_modules\[version]\VstsTaskSdk 层次结构中删除版本目录，我已经没有了。

我还找到了this blog post walking through the process ，看起来我做的一切都是正确的，但我仍然遇到错误。

这是我的文件层次结构:

|-- Wait\ <task root>
  |-- Code\
    |-- Convert-Unit.Tests.ps1
    |-- Convert-Unit.psm1
    |-- Wait.ps1
  |-- ps_modules\
    |-- VstsTaskSdk\
      |-- [All the module files, including VstsTaskSdk.psd1]
  |-- icon.png
  |-- task.json

我在想问题可能是我将我的任务“业务逻辑代码”与“任务基础结构代码”，将其放在 Code 目录中；也就是说，我的 task.json 文件和 Wait.ps1 目标入口点文件不在同一个目录中。按照这个假设，我删除了 Code 目录并将所有文件转储到根目录中，错误消失了(我现在遇到了不同的错误，但看起来已经解决了这个错误)。

在迁移到新的 PowerShell 执行处理程序时，我有什么想法可以使我的“业务逻辑代码”与“任务基础结构代码”分离？我不确定它如何确定应该在哪里查找 ps_modules 目录。

代码也全部开源，欢迎私信look at the repo .

更新

虽然我无法解决如何将 task.json 和目标入口点 PowerShell 脚本文件放在不同目录中的问题，但我能够进行更改，以便所有扩展基础设施代码在根目录中，“业务逻辑”代码在代码目录中。

如你所见in the repo ，我选择在任务根目录中创建一个 task.ps1 文件，并将其用作任务的目标入口点。更新到 PowerShell3 执行处理程序还意味着必须更新我们检索任务输入的方式，因此我使用 task.ps1 文件来获取输入，然后简单地调用Code\Wait.ps1 脚本。这让我可以保持我的代码良好和独立，所以如果 Azure DevOps 决定再次使用新的执行处理程序进行更改，我将不需要触及 Code 目录中的任何代码，只是 task.ps1 文件。

Answer 1

事实上，我认为您尝试的解决方案，将扩展入口脚本(task.ps1) 与SDK 打包文件夹放在同一级别，是您目前的最佳选择。

作为正常的编译过程，当你启动入口脚本时，它会自动从同级文件夹中找到存放.dll文件的文件夹。对于 Azure Devops，这个用于存储 .dll 文件的默认文件夹是 ps_modules。这是设计的默认操作。

这就是为什么您收到有关服务器正在从代码文件夹中查找 .dll 的错误的原因。另外，这也是我们推荐开发者的原因 package the task with SDK如以下布局:

---

将SDK和脚本文件完全分开放在两个文件夹中也不是不可能，只是如果选择这种布局，可以使文件结构非常干净，但会大大增加代码成本(使用$PSScriptRoot覆盖所有SDK加载脚本)，以及后期的维护成本。

创建入口脚本并将其放在与SDK文件夹(ps_modules)相同的文件夹级别，然后从存储在同一文件夹的相关脚本文件中调用函数，是最好的保持方法文件结构干净，保持代码的可维护性，也不会增加额外的代码消耗，导致代码的冗余度增加。