fix(ci): Bring bundle-size-comparison back online #19638
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
github-actions
bot
added
area: build
DLehenbauer
approved these changes
Feb 15, 2024
DLehenbauer
reviewed
Feb 15, 2024
| // The workaround is to override the createAcceptHeader function when making the request to download the artifact. | ||
| // See https://github.com/microsoft/azure-devops-node-api/issues/432 for more details | ||
| const originalCreateAcceptHeader = buildApi.createAcceptHeader; | ||
| buildApi.createAcceptHeader = (type: string): string => type; |
There was a problem hiding this comment.
Nit: The comment in the GH issue is helpful for understanding what the workaround does and why it's necessary. Perhaps replicate it here? (slightly sanitized).
// ADO's APIs try to download pipeline artifacts using an API version that isn't supported
// by the artifact download endpoint.
// One way of getting around that is by temporarily removing the API version to force it to use
// a supported version.
// See: https://github.com/microsoft/azure-devops-node-api/issues/432
The historical information (used to work, 1ES forced our hand, etc.) might be better expressed in the PR comments, since it's explaining the motivation for the delta, not the motivation for the code.
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
The
azure-devops-node-apipackage our build-tools leverage to download pipeline artifacts with baseline bundle size measurements has a known issue when trying to download artifacts created with the newerPublishPipelineArtifacttask in ADO, which we are forced to use since we updated the pipelines to use 1ES pipeline templates (it worked before with thePublishBuildArtifactstask).This PR implements a workaround suggested in the thread linked above to get the download to work.
Reviewer Guidance
The review process is outlined on this wiki page.
Confirmed that the fix works by running danger locally.
The original version of the function that the hack overrides can be seen here.