Update other packages to use http-client v2 #1082
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
brcrista
commented
May 10, 2022
| @@ -5,7 +5,7 @@ import * as cacheHttpClient from '../src/internal/cacheHttpClient' | |||
| import * as cacheUtils from '../src/internal/cacheUtils' | |||
| import {CacheFilename, CompressionMethod} from '../src/internal/constants' | |||
| import * as tar from '../src/internal/tar' | |||
| import {ITypedResponse} from '@actions/http-client/interfaces' | |||
| import {TypedResponse} from '@actions/http-client/lib/interfaces' | |||
There was a problem hiding this comment.
Having to put /lib/ here is a Lerna thing now that we're using the same version of the package that's in the repo.
brcrista
commented
May 10, 2022
Comment on lines
+3
to
+6
| ### 2.0.0 | ||
| - Update to v2.0.0 of `@actions/http-client` | ||
| - The type of the `headers` parameter in the exported function `downloadTool` has been narrowed from `{ [header: string]: any }` to `{ [header: string]: number | string | string[] | undefined; }` (that is, `http.OutgoingHttpHeaders`). | ||
| This is strictly a compile-time change for TypeScript consumers. Previous attempts to use a header value of a type other than those now accepted would have resulted in an error at run time. |
There was a problem hiding this comment.
Note the major version bump. This could be considered a bug fix, but I went with bumping the major version to be conservative.
at-wat
pushed a commit
to at-wat/actions-toolkit
that referenced
this pull request
Aug 31, 2023
We moved `@actions/http-client` to be part of the toolkit in actions#1062. We also made some breaking changes to exported types and released v2. The biggest change in terms of lines of code affected was to get rid of the `I-` prefix for interfaces since TypeScript doesn't follow this convention. I bumped the patch version of all packages except for `tool-cache`, where I bumped the major version. The rationale is explained in the release notes for that package.
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.
We moved
@actions/http-clientto be part of the toolkit in #1062. We also made some breaking changes to exported types and released v2.The biggest change in terms of lines of code affected was to get rid of the
I-prefix for interfaces since TypeScript doesn't follow this convention.I bumped the patch version of all packages except for
tool-cache, where I bumped the major version. The rationale is explained in the release notes for that package.