moby / moby/vpnkit

Homebrew Formula

Open
#498 1 comment 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
OCaml
Stars
1.2k
Forks
214
PR merge metrics
No merged PRs in 30d

Description

I've started looking at what it'll take to get vpnkit into Homebrew-core or at minimum in a tap.

  • I think the main blocking issue is the legacy OPAM version that appears to be required. Looking at the CircleCI config the project is using 1.2.2_4: https://github.com/moby/vpnkit/blob/master/.circleci/config.yml#L19.

  • The makefiles assume they're running from within a git repo. A workaround is to have the brew formula fetch the git repo, but more ideal is fetching the released source tar file from GitHub.

  • The vpnkit tagged version 0.3.0 appears somewhat dated with a number of important fixes since then. It looks like vpnkit in Docker Desktop on macOS is compiled from ea9dbeaf887f5dad8391f4a34d127501fb6bbf64. Would it make sense to tag and release that as 0.4.0 since its already widely deployed?

  • Progress so far: https://github.com/bensallen/homebrew-vpnkit/blob/master/vpnkit.rb

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 with .circleci/config.yml, the makefiles, and the existing vpnkit.rb formula linked in the issue. Check how the current OPAM version, repository assumptions, and tagged 0.3.0 source affect packaging; done means the proposed Homebrew formula can build from an appropriate released source and the release-version question is resolved.

Written by the indexing model from the issue text.

Assessment

Tech stack
ocaml
Domain
build-system, release
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.