feat(ado-ext-telemetry): Embed upload artifact into task

[brocktaylor7]

Details

This removes the need to have a separate publish task for the report artifacts in the azure-pipelines.yml. It is using the special logging commands to upload an artifact in ADO pipelines. It also updates the documentation accordingly.

I ran pipelines for Windows, Ubuntu, and Mac to ensure operability across operating systems. I also ran a test pipeline that still had the publish step defined in the yaml file. It fails with an error stating that the artifact already exists.

• Embed Upload Pipeline runs
  • Ubuntu Latest: Pipelines - Run 20220310.2 logs (azure.com)
  • Windows Latest: Pipelines - Run 20220310.4 logs (azure.com)
  • Mac Latest: Pipelines - Run 20220310.6 logs (azure.com)
  • What happens if pipeline still has publish step for artifacts (it fails that step): Pipelines - Run 20220310.8 logs (azure.com)

Motivation

Feature work, partially addressing #1063

Context

I initially attempted to use the uploadArtifact method defined in the azure-pipelines-task-lib/task library only to find out that under the hood it uses the special logging command via a console.log call. We are capturing and modifying the stdout, and anything that uses a console.log receives a ##debug prefix. Once I realized that the underlying mechanism was to use the logging commands, I switched to using the logging command directly.

Pull request checklist

• [n/a] Addresses an existing issue: Fixes #0000
• Added relevant unit test for your changes. (yarn test)
• Verified code coverage for the changes made. Check coverage report at: <rootDir>/test-results/unit/coverage
• Ran precheckin (yarn precheckin)
• (after PR created) The Accessibility Checks (pull_request) check should fail. All other checks should pass.

[codecov-commenter]

Codecov Report

Merging #1085 (c1e426f) into main (fc1a26c) will increase coverage by 0.23%.
The diff coverage is 100.00%.

❗ Current head c1e426f differs from pull request most recent head ba4dd78. Consider uploading reports for the commit ba4dd78 to get more accurate results

@@            Coverage Diff             @@
##             main    #1085      +/-   ##
==========================================
+ Coverage   89.65%   89.89%   +0.23%     
==========================================
  Files          54       54              
  Lines        1286     1316      +30     
  Branches      151      156       +5     
==========================================
+ Hits         1153     1183      +30     
  Misses        133      133              

Impacted Files	Coverage Δ
...tension/src/output-hooks/ado-stdout-transformer.ts	93.10% <ø> (ø)
...ss-reporter/console/ado-console-comment-creator.ts	95.91% <100.00%> (+1.47%)	⬆️
...s/ado-extension/src/task-config/ado-task-config.ts	100.00% <100.00%> (ø)
...d/src/console-output/result-console-log-builder.ts	100.00% <100.00%> (ø)
...ackages/shared/src/logger/console-logger-client.ts	100.00% <100.00%> (ø)
packages/shared/src/logger/logger.ts	100.00% <100.00%> (ø)
...es/shared/src/mark-down/result-markdown-builder.ts	100.00% <100.00%> (ø)

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update fc1a26c...ba4dd78. Read the comment docs.

[ThanyaLeif]

Nicely done!

Many changes made since initial review :)

[dbjorge]

nit: It might be good to be explicit about how this interacts with uploadResultsAsArtifact by adding a visibleRule for pipeline UX users and a Ignored if uploadResultAsArtifact is false. to the helpMarkdown for yaml users

[dbjorge]

LGTM modulo the minor suggestion for the artifactName settings in task.json