Octokit proxy configuration

[prime-optimus]

I have an enterprise github setup which is behind a proxy. Octokit supports this configuration but there is no notion to pass proxy configuration in @sementic-release/github library.

Am I missing something?

I have tested this by changing the Octokit initialization in the following line (It works!):
https://github.com/semantic-release/github/blob/master/lib/get-client.js#L105

[pvdlg]

It seems the proxy option is deprecated in Octokit: https://github.com/aryannarora/rest.js/blob/master/test/integration/deprecations-test.js#L50.

I don't find any mention of a proxy config in the Readme nor in the API doc.
Looking at the code it seems Octokit uses http-proxy-agent and node-https-proxy-agent which accept the http_proxy environment variables as the proxy URL. Maybe you can try that?

@gr2m what was the proxy option replaced by? Do you have an example of how to set a proxy when instantiating Octokit?

[prime-optimus]

Yes, proxy is deprecated and is replaced by agent configuration. I used https-proxy-agent and it works fine if I change the code, here.

What i really want is to expose proxies as a configuration, either accepting the configuration from upstream callers or as an environment variable so that semantic release can use that.

[pvdlg]

Can you share the code you changed to fix the issue? It's really difficult to see what you mean without the piece of code you are talking about.
Also, as mentioned before, I think there is already environment variable to configure the proxy URL: http_proxy.

[prime-optimus]

I just changed Octokit initialization here to this:

const github = new Octokit({baseUrl, agent: new HttpsProxyAgent("proxy-url")});

Octokit must be initialized with a proxy URL, I hard-coded it for testing, but I can get it from environment variable, http_proxy too.

[semantic-release-bot]

🎉 This issue has been resolved in version 4.3.0 🎉

The release is available on:

• npm package (@next dist-tag)
• GitHub release

Your semantic-release bot 📦🚀

[prime-optimus]

Thanks for the swift release guys! 👍

[pvdlg]

The fact that the target URL is https is independent of the protocol supported by the proxy. You can use an http proxy to reach an https URL and vice-versa.
The environment variable HTTP_PROXY is just a generic name, it doesn't imply that the proxy has to be contacted with http or https nor that the URL you target is http or https.

You should configure HTTP_PROXY to https://your-proxy:3128 if it supports https and you want the communications between the plugin and the proxy to be secured.
If your proxy doesn't support https or you don't want to secure the communication between between the client and the proxy then you can configure HTTP_PROXY to http://your-proxy:3128.

[prime-optimus]

thanks, @pvdlg for the explanation.