Skip to content

Commit 0ca1891

Browse files
committed
docs: update README to clarify proxy support with undici's ProxyAgent
1 parent 3a96fdb commit 0ca1891

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -116,13 +116,15 @@ Can be `false`, a proxy URL or an `Object` with the following properties:
116116
| `secureProxy` | If `true`, then use TLS to connect to the proxy. | `false` |
117117
| `headers` | Additional HTTP headers to be sent on the HTTP CONNECT method. | - |
118118

119-
See [node-https-proxy-agent](https://github.com/TooTallNate/node-https-proxy-agent#new-httpsproxyagentobject-options) and [node-http-proxy-agent](https://github.com/TooTallNate/node-http-proxy-agent) for additional details.
119+
This plugin uses [undici's ProxyAgent](https://github.com/nodejs/undici#proxyagent) for modern proxy support, with backwards compatibility maintained through [node-https-proxy-agent](https://github.com/TooTallNate/node-https-proxy-agent#new-httpsproxyagentobject-options) and [node-http-proxy-agent](https://github.com/TooTallNate/node-http-proxy-agent). This ensures proxy functionality works with GitHub Enterprise Server environments behind corporate proxies.
120120

121121
##### proxy examples
122122

123123
`'http://168.63.76.32:3128'`: use the proxy running on host `168.63.76.32` and port `3128` for each GitHub API request.
124124
`{host: '168.63.76.32', port: 3128, headers: {Foo: 'bar'}}`: use the proxy running on host `168.63.76.32` and port `3128` for each GitHub API request, setting the `Foo` header value to `bar`.
125125

126+
**Note**: This plugin now uses undici's ProxyAgent internally for enhanced proxy support, particularly beneficial for GitHub Enterprise Server environments behind corporate proxies. All existing proxy configurations remain fully compatible.
127+
126128
#### assets
127129

128130
Can be a [glob](https://github.com/isaacs/node-glob#glob-primer) or and `Array` of

0 commit comments

Comments
 (0)