Automatic deploy (build number 523)

conan-io · Aug 4, 2023 · f281859 · f281859
1 parent 492277e
commit f281859
Show file tree

Hide file tree

Showing 497 changed files with 569 additions and 499 deletions.
diff --git a/2.0/404.html b/2.0/404.html
@@ -214,7 +214,7 @@ <h1>Page Not Found<a class="headerlink" href="#page-not-found" title="Permalink
   <div role="contentinfo">
     <p>
         &copy; Copyright 2016-2023, JFrog.
-      Last updated on Jul 28, 2023.
+      Last updated on Aug 04, 2023.
       <span><a href="#" class="ot-sdk-show-settings">Cookies Settings</a></span>
     </p>
   </div> 

diff --git a/2.0/Page Not Found.html b/2.0/Page Not Found.html
@@ -209,7 +209,7 @@ <h1>Page not found</h1>
   <div role="contentinfo">
     <p>
         &copy; Copyright 2016-2023, JFrog.
-      Last updated on Jul 28, 2023.
+      Last updated on Aug 04, 2023.
       <span><a href="#" class="ot-sdk-show-settings">Cookies Settings</a></span>
     </p>
   </div> 

diff --git a/2.0/_sources/knowledge/guidelines.rst.txt b/2.0/_sources/knowledge/guidelines.rst.txt
@@ -70,3 +70,4 @@ Forbidden practices
   like ``conan cache path`` to get information of the current folders. The Conan cache might 
   be checked while debugging, as read-only, but it is not allowed to edit, modify or delete 
   artifacts or files from the Conan cache by any other means that Conan command line or public API.
+- **Sources used in recipes must be immutable**. Once a recipe is exported to the Conan cache, it is expected that the sources are immutable, that is, that retrieving the sources in the future will always retrieve the exact same sources. It is not allowed to use moving targets like a ``git`` branch or a download of a file that is continuously rewritten in the server. ``git`` checkouts must be of an immutable tag or a commit, and ``download()/get()`` must use checksums to verify the server files doesn't change. Not using immutable sources will be undefined behavior.
diff --git a/2.0/_sources/tutorial/creating_packages/create_your_first_package.rst.txt b/2.0/_sources/tutorial/creating_packages/create_your_first_package.rst.txt
@@ -313,6 +313,9 @@ located in the user home folder under the ``.conan2`` folder. Conan will use the
 You already used the :command:`conan list` command to list the recipes and binaries stored
 in the local cache. 
 
+An **important** note: the Conan cache are private to the Conan client - modifying, adding, removing or changing files inside the Conan cache is undefined behaviour likely to cause breakages.
+
+
 Read more
 ---------
 

diff --git a/2.0/_sources/tutorial/creating_packages/handle_sources_in_packages.rst.txt b/2.0/_sources/tutorial/creating_packages/handle_sources_in_packages.rst.txt
@@ -61,6 +61,8 @@ Let's have a look at the changes in the *conanfile.py*:
         default_options = {"shared": False, "fPIC": True}
 
         def source(self):
+            # Please, be aware that using the head of the branch instead of an immutable tag
+            # or commit is not a bad practice and not allowed by Conan
             get(self, "https://github.com/conan-io/libhello/archive/refs/heads/main.zip", 
                       strip_root=True)
 
@@ -100,6 +102,8 @@ We declare a ``source()`` method with this information:
 .. code-block:: python
 
     def source(self):
+        # Please, be aware that using the head of the branch instead of an immutable tag
+        # or commit is strongly discouraged, unsupported by Conan and likely to cause issues
         get(self, "https://github.com/conan-io/libhello/archive/refs/heads/main.zip", 
                   strip_root=True)
 
@@ -109,6 +113,11 @@ it. Note that we pass the ``strip_root=True`` argument so that if all the unzipp
 contents are in a single folder, all the contents are moved to the parent folder (check
 the :ref:`conan.tools.files.unzip()<conan_tools_files_unzip>` reference for more details).
 
+.. warning::
+
+    It is expected that retrieving the sources in the future produces the same results. Using mutable source origins, like a moving reference in git (e.g HEAD branch), or the URL to a file where the contents may change over time, is strongly discouraged and not supported. Not following this practice will result in undefined behavior likely to cause breakages
+
+
 The contents of the zip file are the same as the sources we previously had beside the
 Conan recipe, so if you do a :command:`conan create` the results will be the
 same as before.
@@ -180,15 +189,20 @@ method to clone the `<https://github.com/conan-io/libhello.git>`_ repository in
 default branch using the same folder for cloning the sources instead of a subfolder
 (passing the ``target="."`` argument). 
 
-If we wanted to checkout a commit or tag in the repository we could use the ``checkout()``
+
+.. warning::
+
+    As above, this is only a simple example. The source origine for ``Git()`` also has to be immutable, it is necessary to checkout out an immutable tag or a specific commit to guarantee the correct behavior. Using the HEAD of the repository is not allowed and can cause undefined behavior and breakages.
+
+To checkout a commit or tag in the repository we use the ``checkout()``
 method of the Git tool:
 
 .. code-block:: python
 
     def source(self):
         git = Git(self)
         git.clone(url="https://github.com/conan-io/libhello.git", target=".")
-        git.checkout("<branch name>, <tag> or <commit hash>")
+        git.checkout("<tag> or <commit hash>")
 
 For more information about the ``Git`` class methods, please check the
 :ref:`conan.tools.scm.Git()<reference>` reference.

diff --git a/2.0/changelog.html b/2.0/changelog.html
@@ -638,7 +638,7 @@ <h2>2.0.0-beta1 (20-Jun-2022)<a class="headerlink" href="#beta1-20-jun-2022" tit
   <div role="contentinfo">
     <p>
         &copy; Copyright 2016-2023, JFrog.
-      Last updated on Jul 28, 2023.
+      Last updated on Aug 04, 2023.
       <span><a href="#" class="ot-sdk-show-settings">Cookies Settings</a></span>
     </p>
   </div> 

diff --git a/2.0/conan.pdf b/2.0/conan.pdf
diff --git a/2.0/examples.html b/2.0/examples.html
@@ -279,7 +279,7 @@
   <div role="contentinfo">
     <p>
         &copy; Copyright 2016-2023, JFrog.
-      Last updated on Jul 28, 2023.
+      Last updated on Aug 04, 2023.
       <span><a href="#" class="ot-sdk-show-settings">Cookies Settings</a></span>
     </p>
   </div> 

diff --git a/2.0/examples/commands.html b/2.0/examples/commands.html
@@ -248,7 +248,7 @@
   <div role="contentinfo">
     <p>
         &copy; Copyright 2016-2023, JFrog.
-      Last updated on Jul 28, 2023.
+      Last updated on Aug 04, 2023.
       <span><a href="#" class="ot-sdk-show-settings">Cookies Settings</a></span>
     </p>
   </div> 

diff --git a/2.0/examples/commands/pkglists.html b/2.0/examples/commands/pkglists.html
@@ -408,7 +408,7 @@ <h2>Removing packages lists<a class="headerlink" href="#removing-packages-lists"
   <div role="contentinfo">
     <p>
         &copy; Copyright 2016-2023, JFrog.
-      Last updated on Jul 28, 2023.
+      Last updated on Aug 04, 2023.
       <span><a href="#" class="ot-sdk-show-settings">Cookies Settings</a></span>
     </p>
   </div> 

diff --git a/2.0/examples/conanfile.html b/2.0/examples/conanfile.html
@@ -254,7 +254,7 @@
   <div role="contentinfo">
     <p>
         &copy; Copyright 2016-2023, JFrog.
-      Last updated on Jul 28, 2023.
+      Last updated on Aug 04, 2023.
       <span><a href="#" class="ot-sdk-show-settings">Cookies Settings</a></span>
     </p>
   </div> 

diff --git a/2.0/examples/conanfile/layout.html b/2.0/examples/conanfile/layout.html
@@ -254,7 +254,7 @@
   <div role="contentinfo">
     <p>
         &copy; Copyright 2016-2023, JFrog.
-      Last updated on Jul 28, 2023.
+      Last updated on Aug 04, 2023.
       <span><a href="#" class="ot-sdk-show-settings">Cookies Settings</a></span>
     </p>
   </div> 

diff --git a/2.0/examples/conanfile/layout/conanfile_in_subfolder.html b/2.0/examples/conanfile/layout/conanfile_in_subfolder.html
@@ -323,7 +323,7 @@
   <div role="contentinfo">
     <p>
         &copy; Copyright 2016-2023, JFrog.
-      Last updated on Jul 28, 2023.
+      Last updated on Aug 04, 2023.
       <span><a href="#" class="ot-sdk-show-settings">Cookies Settings</a></span>
     </p>
   </div> 

diff --git a/2.0/examples/conanfile/layout/editable_components.html b/2.0/examples/conanfile/layout/editable_components.html
@@ -351,7 +351,7 @@
   <div role="contentinfo">
     <p>
         &copy; Copyright 2016-2023, JFrog.
-      Last updated on Jul 28, 2023.
+      Last updated on Aug 04, 2023.
       <span><a href="#" class="ot-sdk-show-settings">Cookies Settings</a></span>
     </p>
   </div> 

diff --git a/2.0/examples/conanfile/layout/multiple_subprojects.html b/2.0/examples/conanfile/layout/multiple_subprojects.html
@@ -350,7 +350,7 @@
   <div role="contentinfo">
     <p>
         &copy; Copyright 2016-2023, JFrog.
-      Last updated on Jul 28, 2023.
+      Last updated on Aug 04, 2023.
       <span><a href="#" class="ot-sdk-show-settings">Cookies Settings</a></span>
     </p>
   </div> 

diff --git a/2.0/examples/conanfile/layout/third_party_libraries.html b/2.0/examples/conanfile/layout/third_party_libraries.html
@@ -330,7 +330,7 @@
   <div role="contentinfo">
     <p>
         &copy; Copyright 2016-2023, JFrog.
-      Last updated on Jul 28, 2023.
+      Last updated on Aug 04, 2023.
       <span><a href="#" class="ot-sdk-show-settings">Cookies Settings</a></span>
     </p>
   </div> 

diff --git a/2.0/examples/conanfile/package_info.html b/2.0/examples/conanfile/package_info.html
@@ -250,7 +250,7 @@
   <div role="contentinfo">
     <p>
         &copy; Copyright 2016-2023, JFrog.
-      Last updated on Jul 28, 2023.
+      Last updated on Aug 04, 2023.
       <span><a href="#" class="ot-sdk-show-settings">Cookies Settings</a></span>
     </p>
   </div> 

diff --git a/2.0/examples/conanfile/package_info/components.html b/2.0/examples/conanfile/package_info/components.html
@@ -451,7 +451,7 @@
   <div role="contentinfo">
     <p>
         &copy; Copyright 2016-2023, JFrog.
-      Last updated on Jul 28, 2023.
+      Last updated on Aug 04, 2023.
       <span><a href="#" class="ot-sdk-show-settings">Cookies Settings</a></span>
     </p>
   </div> 

diff --git a/2.0/examples/conanfile/package_info/package_info_conf_and_env.html b/2.0/examples/conanfile/package_info/package_info_conf_and_env.html
@@ -247,7 +247,7 @@
   <div role="contentinfo">
     <p>
         &copy; Copyright 2016-2023, JFrog.
-      Last updated on Jul 28, 2023.
+      Last updated on Aug 04, 2023.
       <span><a href="#" class="ot-sdk-show-settings">Cookies Settings</a></span>
     </p>
   </div> 

diff --git a/2.0/examples/config_files.html b/2.0/examples/config_files.html
@@ -246,7 +246,7 @@
   <div role="contentinfo">
     <p>
         &copy; Copyright 2016-2023, JFrog.
-      Last updated on Jul 28, 2023.
+      Last updated on Aug 04, 2023.
       <span><a href="#" class="ot-sdk-show-settings">Cookies Settings</a></span>
     </p>
   </div> 

diff --git a/2.0/examples/config_files/settings/settings_user.html b/2.0/examples/config_files/settings/settings_user.html
@@ -473,7 +473,7 @@ <h2>Use your new settings<a class="headerlink" href="#use-your-new-settings" tit
   <div role="contentinfo">
     <p>
         &copy; Copyright 2016-2023, JFrog.
-      Last updated on Jul 28, 2023.
+      Last updated on Aug 04, 2023.
       <span><a href="#" class="ot-sdk-show-settings">Cookies Settings</a></span>
     </p>
   </div> 

diff --git a/2.0/examples/cross_build.html b/2.0/examples/cross_build.html
@@ -244,7 +244,7 @@
   <div role="contentinfo">
     <p>
         &copy; Copyright 2016-2023, JFrog.
-      Last updated on Jul 28, 2023.
+      Last updated on Aug 04, 2023.
       <span><a href="#" class="ot-sdk-show-settings">Cookies Settings</a></span>
     </p>
   </div> 

diff --git a/2.0/examples/cross_build/android/android_studio.html b/2.0/examples/cross_build/android/android_studio.html
@@ -473,7 +473,7 @@ <h2>Building the application<a class="headerlink" href="#building-the-applicatio
   <div role="contentinfo">
     <p>
         &copy; Copyright 2016-2023, JFrog.
-      Last updated on Jul 28, 2023.
+      Last updated on Aug 04, 2023.
       <span><a href="#" class="ot-sdk-show-settings">Cookies Settings</a></span>
     </p>
   </div> 

diff --git a/2.0/examples/cross_build/android/ndk.html b/2.0/examples/cross_build/android/ndk.html
@@ -299,7 +299,7 @@ <h2>Read more<a class="headerlink" href="#read-more" title="Permalink to this he
   <div role="contentinfo">
     <p>
         &copy; Copyright 2016-2023, JFrog.
-      Last updated on Jul 28, 2023.
+      Last updated on Aug 04, 2023.
       <span><a href="#" class="ot-sdk-show-settings">Cookies Settings</a></span>
     </p>
   </div> 

diff --git a/2.0/examples/dev_flow.html b/2.0/examples/dev_flow.html
@@ -246,7 +246,7 @@
   <div role="contentinfo">
     <p>
         &copy; Copyright 2016-2023, JFrog.
-      Last updated on Jul 28, 2023.
+      Last updated on Aug 04, 2023.
       <span><a href="#" class="ot-sdk-show-settings">Cookies Settings</a></span>
     </p>
   </div> 

diff --git a/2.0/examples/dev_flow/debug/step_into_dependencies.html b/2.0/examples/dev_flow/debug/step_into_dependencies.html
@@ -305,7 +305,7 @@ <h2>Step into a dependency with Visual Studio<a class="headerlink" href="#step-i
   <div role="contentinfo">
     <p>
         &copy; Copyright 2016-2023, JFrog.
-      Last updated on Jul 28, 2023.
+      Last updated on Aug 04, 2023.
       <span><a href="#" class="ot-sdk-show-settings">Cookies Settings</a></span>
     </p>
   </div> 

diff --git a/2.0/examples/extensions.html b/2.0/examples/extensions.html
@@ -255,7 +255,7 @@
   <div role="contentinfo">
     <p>
         &copy; Copyright 2016-2023, JFrog.
-      Last updated on Jul 28, 2023.
+      Last updated on Aug 04, 2023.
       <span><a href="#" class="ot-sdk-show-settings">Cookies Settings</a></span>
     </p>
   </div> 

diff --git a/2.0/examples/extensions/commands/clean/custom_command_clean_revisions.html b/2.0/examples/extensions/commands/clean/custom_command_clean_revisions.html
@@ -443,7 +443,7 @@ <h3>Conan public API<a class="headerlink" href="#conan-public-api" title="Permal
   <div role="contentinfo">
     <p>
         &copy; Copyright 2016-2023, JFrog.
-      Last updated on Jul 28, 2023.
+      Last updated on Aug 04, 2023.
       <span><a href="#" class="ot-sdk-show-settings">Cookies Settings</a></span>
     </p>
   </div> 

diff --git a/2.0/examples/extensions/commands/custom_commands.html b/2.0/examples/extensions/commands/custom_commands.html
@@ -254,7 +254,7 @@
   <div role="contentinfo">
     <p>
         &copy; Copyright 2016-2023, JFrog.
-      Last updated on Jul 28, 2023.
+      Last updated on Aug 04, 2023.
       <span><a href="#" class="ot-sdk-show-settings">Cookies Settings</a></span>
     </p>
   </div> 

diff --git a/2.0/examples/extensions/deployers/builtin_deployers.html b/2.0/examples/extensions/deployers/builtin_deployers.html
@@ -249,7 +249,7 @@
   <div role="contentinfo">
     <p>
         &copy; Copyright 2016-2023, JFrog.
-      Last updated on Jul 28, 2023.
+      Last updated on Aug 04, 2023.
       <span><a href="#" class="ot-sdk-show-settings">Cookies Settings</a></span>
     </p>
   </div> 

diff --git a/2.0/examples/extensions/deployers/custom_deployers.html b/2.0/examples/extensions/deployers/custom_deployers.html
@@ -254,7 +254,7 @@
   <div role="contentinfo">
     <p>
         &copy; Copyright 2016-2023, JFrog.
-      Last updated on Jul 28, 2023.
+      Last updated on Aug 04, 2023.
       <span><a href="#" class="ot-sdk-show-settings">Cookies Settings</a></span>
     </p>
   </div> 

diff --git a/2.0/examples/extensions/deployers/dev/development_deploy.html b/2.0/examples/extensions/deployers/dev/development_deploy.html
@@ -363,7 +363,7 @@
   <div role="contentinfo">
     <p>
         &copy; Copyright 2016-2023, JFrog.
-      Last updated on Jul 28, 2023.
+      Last updated on Aug 04, 2023.
       <span><a href="#" class="ot-sdk-show-settings">Cookies Settings</a></span>
     </p>
   </div> 

diff --git a/2.0/examples/extensions/deployers/sources/custom_deployer_sources.html b/2.0/examples/extensions/deployers/sources/custom_deployer_sources.html
@@ -318,7 +318,7 @@ <h3>deploy()<a class="headerlink" href="#deploy" title="Permalink to this headli
   <div role="contentinfo">
     <p>
         &copy; Copyright 2016-2023, JFrog.
-      Last updated on Jul 28, 2023.
+      Last updated on Aug 04, 2023.
       <span><a href="#" class="ot-sdk-show-settings">Cookies Settings</a></span>
     </p>
   </div> 

diff --git a/2.0/examples/graph.html b/2.0/examples/graph.html
@@ -252,7 +252,7 @@
   <div role="contentinfo">
     <p>
         &copy; Copyright 2016-2023, JFrog.
-      Last updated on Jul 28, 2023.
+      Last updated on Aug 04, 2023.
       <span><a href="#" class="ot-sdk-show-settings">Cookies Settings</a></span>
     </p>
   </div> 

diff --git a/2.0/examples/graph/requires/consume_cmake_macro.html b/2.0/examples/graph/requires/consume_cmake_macro.html
@@ -314,7 +314,7 @@
   <div role="contentinfo">
     <p>
         &copy; Copyright 2016-2023, JFrog.
-      Last updated on Jul 28, 2023.
+      Last updated on Aug 04, 2023.
       <span><a href="#" class="ot-sdk-show-settings">Cookies Settings</a></span>
     </p>
   </div> 

diff --git a/2.0/examples/graph/tool_requires/different_options.html b/2.0/examples/graph/tool_requires/different_options.html
@@ -337,7 +337,7 @@ <h1>Depending on same version of a tool-require with different options<a class="
   <div role="contentinfo">
     <p>
         &copy; Copyright 2016-2023, JFrog.
-      Last updated on Jul 28, 2023.
+      Last updated on Aug 04, 2023.
       <span><a href="#" class="ot-sdk-show-settings">Cookies Settings</a></span>
     </p>
   </div> 

diff --git a/2.0/examples/graph/tool_requires/different_versions.html b/2.0/examples/graph/tool_requires/different_versions.html
@@ -335,7 +335,7 @@ <h1>Depending on different versions of the same tool-require<a class="headerlink
   <div role="contentinfo">
     <p>
         &copy; Copyright 2016-2023, JFrog.
-      Last updated on Jul 28, 2023.
+      Last updated on Aug 04, 2023.
       <span><a href="#" class="ot-sdk-show-settings">Cookies Settings</a></span>
     </p>
   </div> 

diff --git a/2.0/examples/graph/tool_requires/use_cmake_modules.html b/2.0/examples/graph/tool_requires/use_cmake_modules.html
@@ -326,7 +326,7 @@ <h1>Use cmake modules inside a <code class="docutils literal notranslate"><span
   <div role="contentinfo">
     <p>
         &copy; Copyright 2016-2023, JFrog.
-      Last updated on Jul 28, 2023.
+      Last updated on Aug 04, 2023.
       <span><a href="#" class="ot-sdk-show-settings">Cookies Settings</a></span>
     </p>
   </div> 

diff --git a/2.0/examples/graph/tool_requires/using_protobuf.html b/2.0/examples/graph/tool_requires/using_protobuf.html
@@ -459,7 +459,7 @@
   <div role="contentinfo">
     <p>
         &copy; Copyright 2016-2023, JFrog.
-      Last updated on Jul 28, 2023.
+      Last updated on Aug 04, 2023.
       <span><a href="#" class="ot-sdk-show-settings">Cookies Settings</a></span>
     </p>
   </div> 

diff --git a/2.0/examples/tools.html b/2.0/examples/tools.html
@@ -266,7 +266,7 @@
   <div role="contentinfo">
     <p>
         &copy; Copyright 2016-2023, JFrog.
-      Last updated on Jul 28, 2023.
+      Last updated on Aug 04, 2023.
       <span><a href="#" class="ot-sdk-show-settings">Cookies Settings</a></span>
     </p>
   </div>