aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorKevin Lalumiere <klalumiere@coveo.com>2021-01-25 02:11:02 -0500
committerGitHub <noreply@github.com>2021-01-24 23:11:02 -0800
commitf60b947e1311f72c4dae984a1da0ae7eda4e4048 (patch)
tree847c6adae437a57636bf8d8832682718821f7f86
parentb5e8e48b49d02374de8bf07a16546d3a116fabc7 (diff)
downloadvcpkg-f60b947e1311f72c4dae984a1da0ae7eda4e4048.tar.gz
vcpkg-f60b947e1311f72c4dae984a1da0ae7eda4e4048.zip
[vcpkg] Allow to use Nuget's cache for Nuget binary caching sources (fix #15169) (#15512)
* Fix warning on clang version 10.0.0-4ubuntu1 The warning was ```shell ../src/vcpkg/commands.porthistory.cpp:55:14: error: unused function 'is_date' [-Werror,-Wunused-function] ``` * Add environment variable VCPKG_USE_NUGET_CACHE As the name suggests, this environment variable allow tu use Nuget cache for Nuget binary caching sources. * Document NuGet's Cache environment variable
-rw-r--r--docs/users/binarycaching.md4
-rw-r--r--docs/users/config-environment.md4
-rw-r--r--toolsrc/src/vcpkg/binarycaching.cpp21
3 files changed, 25 insertions, 4 deletions
diff --git a/docs/users/binarycaching.md b/docs/users/binarycaching.md
index ed051b716..07e238f92 100644
--- a/docs/users/binarycaching.md
+++ b/docs/users/binarycaching.md
@@ -197,6 +197,10 @@ or
```
if the appropriate environment variables are defined and non-empty. This is specifically used to associate packages in GitHub Packages with the _building_ project and not intended to associate with the original package sources.
+#### NuGet's cache
+
+NuGet's cache is not used by default. To use it for every nuget-based source, set the [environment variable](config-environment.md) `VCPKG_USE_NUGET_CACHE` to `true` (case-insensitive) or `1`.
+
## Implementation Notes (internal details subject to change without notice)
Binary caching relies on hashing everything that contributes to a particular package build. This includes:
diff --git a/docs/users/config-environment.md b/docs/users/config-environment.md
index 813d2f4de..309a78654 100644
--- a/docs/users/config-environment.md
+++ b/docs/users/config-environment.md
@@ -78,3 +78,7 @@ This environment variable adds or removes binary sources. See [Binary Caching](b
#### VCPKG_NUGET_REPOSITORY
This environment variable changes the metadata of produced NuGet packages. See [Binary Caching](binarycaching.md#Configuration) for more details.
+
+#### VCPKG_USE_NUGET_CACHE
+
+This environment variable allows using NuGet's cache for every nuget-based binary source. See [Binary Caching](binarycaching.md#NuGets-cache) for more details.
diff --git a/toolsrc/src/vcpkg/binarycaching.cpp b/toolsrc/src/vcpkg/binarycaching.cpp
index 58d0584c4..280a5be28 100644
--- a/toolsrc/src/vcpkg/binarycaching.cpp
+++ b/toolsrc/src/vcpkg/binarycaching.cpp
@@ -2,6 +2,7 @@
#include <vcpkg/base/downloads.h>
#include <vcpkg/base/files.h>
#include <vcpkg/base/parse.h>
+#include <vcpkg/base/strings.h>
#include <vcpkg/base/system.debug.h>
#include <vcpkg/base/system.print.h>
#include <vcpkg/base/system.process.h>
@@ -415,7 +416,11 @@ namespace
, m_read_configs(std::move(read_configs))
, m_write_configs(std::move(write_configs))
, m_interactive(interactive)
+ , m_use_nuget_cache(false)
{
+ const std::string use_nuget_cache = System::get_environment_variable("VCPKG_USE_NUGET_CACHE").value_or("");
+ m_use_nuget_cache = Strings::case_insensitive_ascii_equals(use_nuget_cache, "true") ||
+ Strings::case_insensitive_ascii_equals(use_nuget_cache, "1");
}
int run_nuget_commandline(const System::Command& cmdline)
@@ -531,9 +536,7 @@ namespace
.string_arg("-Source")
.string_arg(Strings::join(";", m_read_sources))
.string_arg("-ExcludeVersion")
- .string_arg("-NoCache")
.string_arg("-PreRelease")
- .string_arg("-DirectDownload")
.string_arg("-PackageSaveMode")
.string_arg("nupkg")
.string_arg("-Verbosity")
@@ -543,6 +546,10 @@ namespace
{
cmdline.string_arg("-NonInteractive");
}
+ if (!m_use_nuget_cache)
+ {
+ cmdline.string_arg("-DirectDownload").string_arg("-NoCache");
+ }
cmdlines.push_back(std::move(cmdline));
}
@@ -561,9 +568,7 @@ namespace
.string_arg("-ConfigFile")
.path_arg(cfg)
.string_arg("-ExcludeVersion")
- .string_arg("-NoCache")
.string_arg("-PreRelease")
- .string_arg("-DirectDownload")
.string_arg("-PackageSaveMode")
.string_arg("nupkg")
.string_arg("-Verbosity")
@@ -573,6 +578,10 @@ namespace
{
cmdline.string_arg("-NonInteractive");
}
+ if (!m_use_nuget_cache)
+ {
+ cmdline.string_arg("-DirectDownload").string_arg("-NoCache");
+ }
cmdlines.push_back(std::move(cmdline));
}
@@ -735,6 +744,7 @@ namespace
std::set<PackageSpec> m_restored;
bool m_interactive;
+ bool m_use_nuget_cache;
};
}
@@ -1429,6 +1439,9 @@ void vcpkg::help_topic_binary_caching(const VcpkgPaths&)
"\n"
"if the appropriate environment variables are defined and non-empty.\n");
tbl.blank();
+ tbl.text("NuGet's cache is not used by default. To use it for every nuget-based source, set the environment "
+ "variable `VCPKG_USE_NUGET_CACHE` to `true` (case-insensitive) or `1`.\n");
+ tbl.blank();
System::print2(tbl.m_str);
const auto& maybe_cachepath = default_cache_path();
if (auto p = maybe_cachepath.get())