Clean up unused parameter and stray escape in upload template#5242
Conversation
Two small unrelated cleanups in the BCS upload templates: 1) upload-build-artifacts-job.yml — drop the trailing backslash in the 'Upload Build Artifact …\\' job displayName. In YAML single-quoted strings, backslash is a literal character (only \''\ escapes a quote), so this currently renders in the AzDO UI as a stray 'Upload Build Artifact <name>\\'. Removing it is purely cosmetic. 2) upload-build-artifacts-jobs.yml — remove the unused 'mauiFramework' template parameter. It was declared on the dispatcher but never referenced in the dispatcher body, and no current caller passes it to this template (dotnet/runtime's perf-build.yml passes mauiFramework only to runtime-perf-build-jobs.yml, not to upload-build-artifacts-jobs.yml). Safe to drop. Intentionally NOT removed: the 'runtimeRepoAlias' parameter on upload-build-artifacts-jobs.yml is also unused in the dispatcher body, but dotnet/runtime's perf-build.yml DOES pass it explicitly. Dropping it here would fail template expansion on the runtime side with 'Unexpected parameter ''runtimeRepoAlias'''. Cleaning that up requires a coordinated dotnet/runtime tenant update first and is left for a follow-up PR. No behavioral change for any current caller. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
Removes two minor cosmetic/template cleanup issues in the BCS upload pipeline YAML to reduce confusion and avoid UI noise, without changing upload behavior.
Changes:
- Removed an unused
mauiFrameworkparameter from the upload dispatcher template (upload-build-artifacts-jobs.yml). - Fixed a stray trailing backslash in the per-artifact upload job
displayNameso it renders correctly in AzDO UI.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| eng/pipelines/upload-build-artifacts-jobs.yml | Drops unused mauiFramework parameter from the upload dispatcher template interface. |
| eng/pipelines/templates/upload-build-artifacts-job.yml | Removes stray \ from the per-artifact job display name to avoid literal backslash rendering. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| runtimeRepoAlias: runtime | ||
| performanceRepoAlias: self | ||
| buildType: [] | ||
| mauiFramework: '' |
There was a problem hiding this comment.
Is this not used anywhere, because we got rid of the maui builds?
There was a problem hiding this comment.
Moreso we are not currently passing it through when we upload the artifacts themselves. This is definitely something we can improve on as I think the builds for mauiFramework are likely not running latest, but we will also need to think about how that affects our storage pathing and flow for the BCS.
There was a problem hiding this comment.
It is still used in the actual build steps IIRC, this is just the artifact uploading.
DrewScoggins
left a comment
There was a problem hiding this comment.
LGTM, barring the one question on removal of mauiFramework.
What
Two small unrelated cleanups in the existing BCS upload pipeline templates. No behavioral change.
1.
eng/pipelines/templates/upload-build-artifacts-job.ymlDrop the trailing backslash in the per-artifact job displayName:
YAML single-quoted strings treat
\as a literal character (the only escape inside a single-quoted string is''for a single quote). With the current\', the AzDO Web UI literally renders the job name asUpload Build Artifact <name>\. Cosmetic only — the job still runs.2.
eng/pipelines/upload-build-artifacts-jobs.ymlRemove the unused
mauiFrameworktemplate parameter:parameters: runtimeRepoAlias: runtime performanceRepoAlias: self buildType: [] - mauiFramework: ''The parameter is declared on the dispatcher but never referenced in the dispatcher body, and no current caller passes it to this template.
dotnet/runtime'sperf-build.ymlpassesmauiFrameworkonly to the siblingruntime-perf-build-jobs.ymltemplate (used by the Build stage), not toupload-build-artifacts-jobs.yml(used by the UploadArtifacts stage). Dropping it removes a confusing dead parameter that suggests upload behavior depends on the MAUI framework version (it doesn't).Why
Both items surfaced during code review of #5241 (the dispatcher generalization for multi-tenant uploads). Splitting them into this small, easily reviewed PR keeps #5241 focused on the generalization story.
Intentionally NOT removed
The
runtimeRepoAliasparameter onupload-build-artifacts-jobs.ymlis also unused in the dispatcher body — butdotnet/runtime'sperf-build.ymldoes explicitly passruntimeRepoAlias: selfto this template. Removing the parameter here would fail template expansion on the runtime side at the next pipeline run withUnexpected parameter 'runtimeRepoAlias'. Cleaning that up requires a coordinateddotnet/runtimetenant update first, and is left for a follow-up PR.Validation
yaml.safe_load).git --no-pager grep mauiFrameworkindotnet/runtimeconfirms no UploadArtifacts caller passes the parameter.dotnet/performanceitself (this template has no internal callers — only external tenants likedotnet/runtime).