QUERY · ISSUE

mip: github branch is incorrectly used for secondary github: sources in package.json

openby ned-pcsopened 2023-06-12updated 2023-06-12

mip version 0.2.0

When you specify a version to mip.install() to reference a particular GitHub branch, this branch is used for every github: source in the package.json, even those coming from a different repository.

The best solution to this is probably:

provide a way (perhaps an optional third field) for a URL to specify a different branch
default the branch to HEAD for secondary github: urls if they don't provide an explicit branch

In my PR #676 I have done the second part of this (default to HEAD) but not the first part yet.

CANDIDATE · PULL REQUEST

docs/reference/packages: add GitHub repo to package.json example as dependency

mergedby brainelectronicsopened 2023-05-27updated 2023-06-02

docs

Also add some clarification on how to use the package.json with a dependency to a GitHub repo and a branch

Assessment

Q Qwen · high

Issue #677 reports a bug in the mip package manager where specifying a version/branch for the primary source incorrectly applies that branch to all github: sources in package.json. The candidate PR #11634 is a documentation update that adds examples and clarification about using GitHub repos with branches in package.json. While both items relate to mip and package.json with GitHub dependencies, the PR does not fix the underlying bug described in the issue - it only documents how to use the feature. The bug fix would require code changes to the mip module's URL resolution logic, not documentation updates.

Suggested action

Keep issue #677 open as a bug report. The documentation PR #11634 provides useful context but does not resolve the reported bug. A separate PR implementing the fix (defaulting secondary github sources to HEAD or allowing per-source branch specification) is needed.

mip: github branch is incorrectly used for secondary github: sources in package.json

docs/reference/packages: add GitHub repo to package.json example as dependency

Keyboard