Sync Docs platformio/platformio-core@841489c

platformio · Feb 14, 2025 · 33d5f42 · 33d5f42
1 parent 7b9c779
commit 33d5f42
Show file tree

Hide file tree

Showing 3 changed files with 43 additions and 13 deletions.
diff --git a/en/latest/_sources/integration/ci/gitlab.rst.txt b/en/latest/_sources/integration/ci/gitlab.rst.txt
@@ -48,10 +48,15 @@ This variant is default choice for native PlatformIO projects:
 
     image: python:3.11
 
+    # Change cache directories to be inside the project directory since GitLab can only cache local items.
+    variables:  
+      PIP_CACHE_DIR: "$CI_PROJECT_DIR/.cache/pip"
+      PLATFORMIO_CACHE_DIR: "$CI_PROJECT_DIR/.cache/platformio"
+
     cache:
       paths:
-        - ~/.cache/pip
-        - ~/.platformio/.cache
+        - .cache/pip
+        - .cache/platformio
 
     stages:
      - test
@@ -75,10 +80,15 @@ and boards from command line interface:
 
     image: python:3.11
 
+    # Change cache directories to be inside the project directory since GitLab can only cache local items.
+    variables:  
+      PIP_CACHE_DIR: "$CI_PROJECT_DIR/.cache/pip"
+      PLATFORMIO_CACHE_DIR: "$CI_PROJECT_DIR/.cache/platformio"
+
     cache:
       paths:
-        - ~/.cache/pip
-        - ~/.platformio/.cache
+        - .cache/pip
+        - .cache/platformio
 
     stages:
      - test
@@ -102,10 +112,15 @@ Examples
 
     image: python:3.11
 
+    # Change cache directories to be inside the project directory since GitLab can only cache local items.
+    variables:  
+      PIP_CACHE_DIR: "$CI_PROJECT_DIR/.cache/pip"
+      PLATFORMIO_CACHE_DIR: "$CI_PROJECT_DIR/.cache/platformio"
+
     cache:
       paths:
-        - ~/.cache/pip
-        - ~/.platformio/.cache
+        - .cache/pip
+        - .cache/platformio
 
     stages:
      - test

diff --git a/en/latest/integration/ci/gitlab.html b/en/latest/integration/ci/gitlab.html
@@ -195,10 +195,15 @@ <h3><a class="toc-backref" href="#id4" role="doc-backlink">Using <a class="refer
 <p>This variant is default choice for native PlatformIO projects:</p>
 <div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="nt">image</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">python:3.11</span>
 
+<span class="c1"># Change cache directories to be inside the project directory since GitLab can only cache local items.</span>
+<span class="nt">variables</span><span class="p">:</span>
+<span class="w">  </span><span class="nt">PIP_CACHE_DIR</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;$CI_PROJECT_DIR/.cache/pip&quot;</span>
+<span class="w">  </span><span class="nt">PLATFORMIO_CACHE_DIR</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;$CI_PROJECT_DIR/.cache/platformio&quot;</span>
+
 <span class="nt">cache</span><span class="p">:</span>
 <span class="w">  </span><span class="nt">paths</span><span class="p">:</span>
-<span class="w">    </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">~/.cache/pip</span>
-<span class="w">    </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">~/.platformio/.cache</span>
+<span class="w">    </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">.cache/pip</span>
+<span class="w">    </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">.cache/platformio</span>
 
 <span class="nt">stages</span><span class="p">:</span>
 <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">test</span>
@@ -219,10 +224,15 @@ <h3><a class="toc-backref" href="#id5" role="doc-backlink">Using <a class="refer
 and boards from command line interface:</p>
 <div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="nt">image</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">python:3.11</span>
 
+<span class="c1"># Change cache directories to be inside the project directory since GitLab can only cache local items.</span>
+<span class="nt">variables</span><span class="p">:</span>
+<span class="w">  </span><span class="nt">PIP_CACHE_DIR</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;$CI_PROJECT_DIR/.cache/pip&quot;</span>
+<span class="w">  </span><span class="nt">PLATFORMIO_CACHE_DIR</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;$CI_PROJECT_DIR/.cache/platformio&quot;</span>
+
 <span class="nt">cache</span><span class="p">:</span>
 <span class="w">  </span><span class="nt">paths</span><span class="p">:</span>
-<span class="w">    </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">~/.cache/pip</span>
-<span class="w">    </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">~/.platformio/.cache</span>
+<span class="w">    </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">.cache/pip</span>
+<span class="w">    </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">.cache/platformio</span>
 
 <span class="nt">stages</span><span class="p">:</span>
 <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">test</span>
@@ -246,10 +256,15 @@ <h2><a class="toc-backref" href="#id6" role="doc-backlink">Examples</a><a class=
 </ol>
 <div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="nt">image</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">python:3.11</span>
 
+<span class="c1"># Change cache directories to be inside the project directory since GitLab can only cache local items.</span>
+<span class="nt">variables</span><span class="p">:</span>
+<span class="w">  </span><span class="nt">PIP_CACHE_DIR</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;$CI_PROJECT_DIR/.cache/pip&quot;</span>
+<span class="w">  </span><span class="nt">PLATFORMIO_CACHE_DIR</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;$CI_PROJECT_DIR/.cache/platformio&quot;</span>
+
 <span class="nt">cache</span><span class="p">:</span>
 <span class="w">  </span><span class="nt">paths</span><span class="p">:</span>
-<span class="w">    </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">~/.cache/pip</span>
-<span class="w">    </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">~/.platformio/.cache</span>
+<span class="w">    </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">.cache/pip</span>
+<span class="w">    </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">.cache/platformio</span>
 
 <span class="nt">stages</span><span class="p">:</span>
 <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">test</span>

diff --git a/en/latest/searchindex.js b/en/latest/searchindex.js