actions / actions/toolkit

Introduce GITHUB_PROXY environment variable support in http-client

Open
#1,664 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
TypeScript
Stars
5.9k
Forks
1.8k
PR merge metrics
No merged PRs in 30d

Description

Describe the enhancement
For complex setup with self-hosted Github Action runners were all requests toward Github hosted servers needs to go thru an intercepting webproxy please introduce support for aenvironment variable like GITHUB_PROXY or GITHUB_HTTPS_PROXY.

When the http-client detects an access towards a server hosted by GitHub, use the proxy server defined in GITHUB_PROXY.

Currently self-hosted github action runners need to set HTTPS_PROXY and NO_PROXY, which is hard to get right in a strict setups, as the semantic is wrong: it's deny listing (in NO_PROXY) instead of allow listing only certain target hosts.

By introducing a special GITHUB_PROXY or GITHUB_HTTPS_PROXY variable all traffic toward GITHUB could be forced thru intercepting web proxy, but no other traffic would be routed thru any proxy, as HTTPS_PROXY, HTTP_PROXY and NO_PROXY are widely used in different syntaxes by all kind of software.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the http-client entry point and its existing handling of HTTPS_PROXY, HTTP_PROXY, and NO_PROXY. Determine how requests to GitHub-hosted servers are identified, then add support for the requested GitHub-specific proxy environment variable without routing unrelated traffic through it; verify the behavior with the project's existing tests.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
networking
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.