fsprojects / fsprojects/Paket

Changing the paket tool path

Open
#3,591 3 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

I'm using paket within a monorepo with potentially many applications in it. For portability I want to commit a paket.exe bootstrapper tool to the repo, but for space/performance reasons I'd really rather only commit one of these binary files rather than one for each app. Ideally I would commit it to ./.paket/paket.exe at the root and each app within it would know to use the tool up there for restore commands rather than look for it in the .paket folder in the app's own root, where its dependencies and lock files are.

This works ok by changing the Paket.Restore.targets' PaketToolsPath property to the out-of-convention path, except that every time a paket command is run it attempts to revert the file back to its default. At some point a dev is bound to run a build, accidentally commit the re-generated file, and break the build for everyone else. Also it's a bit annoying to keep undoing the overwrite instead.

Is it possible there could be an option added to not overwrite Paket.Restore.targets on paket commands if it already exists, eg. in paket.dependencies or better in Paket.Restore.targets itself? At the moment using paket in a monorepo (not my choice) means committing many (admittedly, relatively small) binary files which bloats the repo and feels a bit unnecessary.

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 inspecting Paket.Restore.targets and the paket command behavior that regenerates it, along with the possible configuration location in paket.dependencies. Done means a monorepo can use a shared ./.paket/paket.exe without commands overwriting an existing custom PaketToolsPath configuration.

Written by the indexing model from the issue text.

Assessment

Domain
build-system, tooling
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.