fsprojects / fsprojects/Paket

Paket GitHub references when file location is modified

Open
#3,152 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
F#
Stars
2.1k
Forks
528
Avg merge
1d 12m
Merged PRs (30d)
54

Description

GitHub repository maintainers tend to move the file locations and branches:

  • Current master comes version-04-legacy
  • Some referenced file location is moved from the e.g. root folder to e.g. bin folder

Now, when you run paket restore and install, it works, but outdated and update script will fail totally. This is very annoying when you have 30 GitHub references and would like to update only few components: some of the 30 has always modified something and everything fails.

  • Paket already has the GitHub commit hash identity, so there is no reason to fail if the branch has changed.
  • Paket could give a warning if the file is deleted, but there is no reason to hard failure: the file can still be restored via the commit hash.

Some examples to try:

Font-Awesome did move under another branch (FortAwesome/Font-Awesome:fa-4) and danielm/uploader just removed file from the current master.

Old paket.dependeces

github FortAwesome/Font-Awesome fonts/fontawesome-webfont.svg
github danielm/uploader demos/js/demo-preview.js

Old paket.lock

GITHUB
  remote: FortAwesome/Font-Awesome
    fonts/fontawesome-webfont.svg (48a7d9db28d450571a0882810d1591a2fadc39c6)
  remote: danielm/uploader
    demos/js/demo-preview.js (125c50236acc69c72171624e51378ffbed3c63dd)

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 with Paket's outdated and update commands and compare how they handle the GitHub references shown in paket.dependencies and paket.lock with restore and install. Reproduce the Font-Awesome and danielm/uploader examples; done means branch or path changes no longer cause a hard failure when the locked commit still contains the file, while a deleted file may produce a warning.

Written by the indexing model from the issue text.

Assessment

Tech stack
fsharp, git, github
Domain
tooling
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.