Skip to content

Make packages folder optional #2638

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
matthid merged 19 commits into from
Aug 26, 2017
Merged

Make packages folder optional #2638

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
19 commits
Select commit Hold shift + click to select a range
5bb0d58
Initial scetch in making the packages folder optional
matthid Aug 20, 2017
42a5b28
implement paket-file changes.
matthid Aug 20, 2017
e6b4076
create directory before downloading if it doesn't exist.
matthid Aug 20, 2017
2a681b8
check if file needs to be copied and replace if needed.
matthid Aug 20, 2017
926a246
add 'PackageInfo' to fallback to group settings automatically (for al…
matthid Aug 20, 2017
2be27a1
add some docs around the storage option.
matthid Aug 20, 2017
43a5658
garbage collector can ignore not existing directories
matthid Aug 20, 2017
31c28f3
some cleanup
matthid Aug 21, 2017
1efc73d
Merge remote-tracking branch 'origin/master' into packages_folder
matthid Aug 21, 2017
f5250f6
Merge branch 'master' of github.com:fsprojects/Paket into packages_fo…
matthid Aug 21, 2017
aa44580
Merge branch 'master' of github.com:fsprojects/Paket into packages_fo…
matthid Aug 21, 2017
518c918
Merge branch 'master' of github.com:fsprojects/Paket into packages_fo…
matthid Aug 25, 2017
48341bd
make isExtracted ignore any existing license files (this might be foo…
matthid Aug 26, 2017
27da527
more docs
matthid Aug 26, 2017
f151827
create directory if it doesn't exist
matthid Aug 26, 2017
d3d1c80
GetFullPath can throw
matthid Aug 26, 2017
38ba8b3
try to find the path which is too long...
matthid Aug 26, 2017
1b88f14
get rid of GetFullPath
matthid Aug 26, 2017
0911a8b
fix path too long in integration test
matthid Aug 26, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
more docs
  • Loading branch information
@matthid
matthid committed Aug 26, 2017
commit 27da527fa4d3e27aaf8d50c86bc15c86f44a26bc
16 changes: 14 additions & 2 deletions docs/content/dependencies-file.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -157,8 +157,19 @@ If you change the target framework of the projects then you need to run

### Disable packages folder

You can opt-out of generating the `packages` folder by using the `storage` option:
With the net netcore release and the switch to provide more and more netstandard-only packages
the Paket team noticed an dramatic increase of the well known "packages" folder.
Historically one way was to tell Paket that you only want to compile for `framework: net45`.
However, this doesn't prevent netstandard dependencies in all situations.
On the other side more features are provided by Paket and the packages folder has become more and more redundant:
- Load scripts can reference the files in the global cache
- csproj/fsproj files can references files in the global cache
- netcore project files don't require any explicit dll-references
Therefore, the paket team decided to make the "packages" folder opt-out.

> This feature is currently considered beta

You can opt-out of generating the `packages` folder by using the `storage` option:

```paket
// Do not extract into the "packages" folder but use a globally shared directory
Expand All @@ -168,7 +179,8 @@ source https://nuget.org/api/v2
nuget jQuery
```

The storage option may be overriden by packages.
The storage option may be overriden by packages.
However, the behavior is undefined and may change (please open an issue if you depend on the current behavior or we break you).

### Controlling whether content files should be copied to the project

Expand Down
4 changes: 4 additions & 0 deletions docs/content/paket-and-dotnet-cli.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,10 @@ allows you to use specialized NuGet packages that provide `dotnet` CLI tools.

CLI tools are only available for .NET SDK-based projects.

> Consider setting `storage: none` in your dependencies file for the relevant groups to mirror NuGet behavior and
> not copy all dependencies to the packages folder. This will keep your repository folder small and clean.
> Please read the relevant section of the [`paket.dependencies` file](dependencies-file.html) documentation.

### Installing dependencies

Install all required packages with:
Expand Down