Shopify / Shopify/tapioca

Allow user to override raw github sources

Open
#1,992 5 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

help-wanted
Dominant language
Ruby
Stars
873
Forks
164
Avg merge
4d 27m
Merged PRs (30d)
9

Description

As title, access to raw.githubusercontent.com is an issue for Chinese users, and when running bundle exec tapioca init, I got the following:

$ bundle exec tapioca init
   identical  sorbet/config
   identical  sorbet/tapioca/config.yml
   identical  sorbet/tapioca/require.rb
       force  bin/tapioca
Retrieving index from central repository... 
Can't fetch file `index.json` from https://raw.githubusercontent.com/Shopify/rbi-central/main (Failed to open TCP connection to raw.githubusercontent.com:443 (Connection refused - connect(2) for "raw.githubusercontent.com" port 443))

Tapioca can't access the annotations at https://raw.githubusercontent.com/Shopify/rbi-central/main.

Are you trying to access a private repository?
If so, please specify your Github credentials in your ~/.netrc file or by specifying the --auth option.

See https://github.com/Shopify/tapioca#using-a-netrc-file for more details.
Can't fetch annotations without sources (no index fetched)

Contributor guide

No contributing guide indexed for this repository

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 tracing the source retrieval used by bundle exec tapioca init, especially its access to https://raw.githubusercontent.com/Shopify/rbi-central/main. Determine where an override can be configured and how it should affect fetching index.json and annotations; done means users can select an alternate raw GitHub source and initialization completes without the connection error.

Written by the indexing model from the issue text.

Assessment

Tech stack
github, ruby
Domain
cli, tooling
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.