PublishCodeCoverageResults@2 - 發佈程式代碼涵蓋範圍結果 v2 工作

發行項
11/08/2024

使用此工作可從組建取得程式代碼涵蓋範圍結果。

語法

# Publish code coverage results v2
# Publish any of the code coverage results from a build.
- task: PublishCodeCoverageResults@2
  inputs:
    summaryFileLocation: # string. Required. Path to summary files. 
    #pathToSources: # string. Path to Source files. 
    #failIfCoverageEmpty: false # boolean. Fail if code coverage results are missing. Default: false.

輸入

summaryFileLocation - 摘要檔案的路徑
string。必填。

指定包含程式代碼涵蓋範圍統計數據的摘要檔案路徑，例如行、方法和類別涵蓋範圍。多個摘要檔案會合併成單一報表。值可能包含迷你模式。例如：$(System.DefaultWorkingDirectory)/MyApp/**/site/cobertura/coverage.xml。迷你模式的詳細資訊。

pathToSources - 來源檔案的路徑
string。

當涵蓋範圍 XML 報表不包含來源檔案的絕對路徑時，需要指定來源檔案的路徑。例如，JaCoCo 報表不會使用絕對路徑，因此在發布 Java 應用程式的 JaCoCo 涵蓋範圍時，模式類似於 $(System.DefaultWorkingDirectory)/MyApp/src/main/java/。此輸入應該指向主機上來源檔案的絕對路徑。例如，$(System.DefaultWorkingDirectory)/MyApp/。

如果在 Docker 容器中執行測試，可以使用此輸入。

如果遺漏程式代碼涵蓋範圍結果，failIfCoverageEmpty - 失敗
boolean。預設值：false。

如果程式代碼涵蓋範圍未產生任何要發佈的結果，工作就會失敗。

工作控制選項

除了工作輸入之外，所有工作都有控制選項。如需詳細資訊，請參閱控制項選項和一般工作屬性。

輸出變數

沒有。

言論

在組建管線中使用這項工作，將執行測試時所產生的程式代碼涵蓋範圍結果發佈至 Azure Pipelines 或 TFS，並在產生涵蓋範圍 xml 檔案之後，以取得管線中的程式代碼涵蓋範圍索引卷標和涵蓋範圍報告詳細數據。工作支援程式代碼涵蓋範圍產生的 xml 格式。此工作會產生包含程式代碼涵蓋範圍詳細數據的 cjson 檔案。它也會在組建成品底下產生程式代碼涵蓋範圍 HTML 報告。

只有在組建管線中才支援這項工作，而不是發行管線。

Visual Studio Test、.NET Core、Ant、Maven、Gulp和 Grunt 等工作也會提供將程式代碼涵蓋範圍數據發佈至管線的選項。如果您使用這些工作，則不需要管線中的個別發佈程式代碼涵蓋範圍結果工作。

必要條件 - 若要在管線中使用 [發佈程式代碼涵蓋範圍結果 v2] 工作，請使用 dotnet 7.0.x 工作作為管線中的必要條件。使用發佈程式代碼涵蓋範圍 v2 工作之前的 dotnet core 工作。

先決條件

若要使用 YAML 管線設定必要條件：

# Dotnet core sdk task 7.0.x
- task: UseDotNet@2
  displayName: 'Use .NET Core sdk 7.0.x'
  inputs:
    version: 7.0.x

若要使用設計工具設定必要條件：

顯示管線中 .Net Core Sdk 工作的螢幕快照。

使用下列設定來設定發行程式代碼涵蓋範圍結果第 2 版工作。
建置完成並發行程式代碼涵蓋範圍結果 v2 工作成功之後，請選取管線執行摘要中的 [程式代碼涵蓋範圍] 索引卷標，以檢視程式代碼涵蓋範圍結果。

使用 YAML 搭配伊斯坦布爾的 JavaScript 程式代碼涵蓋範圍結果

若要使用 YAML 發佈 JavaScript 的程式代碼涵蓋範圍結果，請參閱這些主題的生態系統一節中的自定義 JavaScript，其中也包含其他語言的範例。

請參閱使用 Cobertura發佈程式代碼涵蓋範圍的範例。

碼頭工人

對於使用 Docker 的應用程式，建置和測試可能會在容器內執行，並在容器內產生程式代碼涵蓋範圍結果。若要將結果發佈至管線，應該將產生的成品提供給 發佈程式代碼涵蓋範圍結果 工作。如需參考，您可以在組建、測試及發行結果的 Docker 檔案一節底下，看到類似的範例來發佈測試結果，Docker。

檢視結果

若要檢視管線中的程式代碼涵蓋範圍結果，請參閱檢閱程式代碼涵蓋範圍結果。

已知問題

發佈程式代碼涵蓋範圍結果 v2 工作會產生 cjson 檔案，並在程式代碼涵蓋範圍索引標籤下發佈程式代碼涵蓋範圍報告。它也會產生組建成品，這是一組從主要 index.html 檔案連結的 HTML 檔案。如果程式代碼涵蓋範圍索引標籤無法顯示程式代碼涵蓋範圍報告，請檢查輸入程式代碼涵蓋範圍 xml 檔案的格式是否正確，並且具有有效的詳細數據。

要求

要求	描述
管線類型	YAML，傳統組建
執行於	代理
需求	沒有
功能	此工作不符合作業中後續工作的任何需求。
命令限制	任何
Settable 變數	任何
代理程式版本	2.144.0 或更新
工作類別	測試

另請參閱

發佈測試結果

共用方式為