micropython / micropython/micropython-lib
mip: github branch is incorrectly used for secondary github: sources in package.json
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 2.9k
- Forks
- 1.1k
- Avg merge
- 7d 6h
- Merged PRs (30d)
- 3
Description
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.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with mip.install() handling of versioned GitHub sources and inspect package.json parsing, then review PR #676 for the existing secondary-source behavior. Done means a branch selected for one GitHub repository is not incorrectly applied to other repositories, while the issue's separate-branch requirement is addressed or clearly scoped.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- tooling
- Issue type
- Bug
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 30/100