docs: auto-build docs for [email protected]

appium · Apr 2, 2024 · a7e612f · a7e612f
1 parent 4f26b6f
commit a7e612f
Show file tree

Hide file tree

Showing 5 changed files with 57 additions and 48 deletions.
diff --git a/7.9/guides/run-prebuilt-wda/index.html b/7.9/guides/run-prebuilt-wda/index.html
@@ -1529,9 +1529,9 @@
 
 <!-- Table of contents item -->
 <li class="md-nav__item">
-  <a href="#capabilities-for-prebuilt-wda-with-appiumusexctestrunfile" class="md-nav__link">
+  <a href="#capabilities-for-prebuilt-wda-with-appiumusexctestrunfile-appiumuseprebuiltwda-or-appiumprebuildwda" class="md-nav__link">
     <span class="md-ellipsis">
-      Capabilities for Prebuilt WDA with appium:useXctestrunFile
+      Capabilities for Prebuilt WDA with appium:useXctestrunFile, appium:usePrebuiltWDA or appium:prebuildWDA
     </span>
   </a>
 
@@ -2065,9 +2065,9 @@
 
 <!-- Table of contents item -->
 <li class="md-nav__item">
-  <a href="#capabilities-for-prebuilt-wda-with-appiumusexctestrunfile" class="md-nav__link">
+  <a href="#capabilities-for-prebuilt-wda-with-appiumusexctestrunfile-appiumuseprebuiltwda-or-appiumprebuildwda" class="md-nav__link">
     <span class="md-ellipsis">
-      Capabilities for Prebuilt WDA with appium:useXctestrunFile
+      Capabilities for Prebuilt WDA with appium:useXctestrunFile, appium:usePrebuiltWDA or appium:prebuildWDA
     </span>
   </a>
 
@@ -2216,7 +2216,7 @@ <h2 id="how-xcodebuild-works">How <code>xcodebuild</code> Works<a class="headerl
   commands for the target device.</p>
 </li>
 </ul>
-<h2 id="capabilities-for-prebuilt-wda-with-appiumusexctestrunfile">Capabilities for Prebuilt WDA with <code>appium:useXctestrunFile</code><a class="headerlink" href="#capabilities-for-prebuilt-wda-with-appiumusexctestrunfile" title="Permanent link">&para;</a></h2>
+<h2 id="capabilities-for-prebuilt-wda-with-appiumusexctestrunfile-appiumuseprebuiltwda-or-appiumprebuildwda">Capabilities for Prebuilt WDA with <code>appium:useXctestrunFile</code>, <code>appium:usePrebuiltWDA</code> or <code>appium:prebuildWDA</code><a class="headerlink" href="#capabilities-for-prebuilt-wda-with-appiumusexctestrunfile-appiumuseprebuiltwda-or-appiumprebuildwda" title="Permanent link">&para;</a></h2>
 <p>The XCUITest driver provides two capabilities that allow skipping the <code>build-for-testing</code> command,
 and executing only the <code>test-without-building</code> command: <strong><code>appium:useXctestrunFile</code></strong> and
 <strong><code>appium:bootstrapPath</code></strong> (see <a href="../../reference/capabilities/#webdriveragent">Capabilities</a>).</p>
@@ -2239,9 +2239,13 @@ <h2 id="capabilities-for-prebuilt-wda-with-appiumusexctestrunfile">Capabilities
 <a id="__codelineno-4-8" name="__codelineno-4-8" href="#__codelineno-4-8"></a><span class="p">}</span>
 </code></pre></div>
 <p>Not all combinations have been tested, but the target device can probably be anything.</p>
-<p>The same thing can be achieved with the <code>appium:derivedDataPath</code> and <code>appium:usePrebuiltWDA</code>
+<p>The same thing can be achieved with the <strong><code>appium:derivedDataPath</code></strong> and <strong><code>appium:usePrebuiltWDA</code></strong>
 capabilities, but this may fail if <code>xcodebuild</code> cannot find or handle the <code>.xctestrun</code> file
 properly. The stability depends on Xcode.</p>
+<p><strong><code>appium:prebuildWDA</code></strong> lets the XCUITest driver build the WDA before running it, then the session
+will be handled with <code>appium:usePrebuiltWDA</code>.
+It might have additional building steps than with <code>appium:derivedDataPath</code> and <code>appium:usePrebuiltWDA</code>
+combination, but it could help <code>appium:usePrebuiltWDA</code> to not manage the WDA project.</p>
 <h2 id="capabilities-for-prebuilt-wda-with-appiumprebuiltwdapath">Capabilities for Prebuilt WDA with <code>appium:prebuiltWDAPath</code><a class="headerlink" href="#capabilities-for-prebuilt-wda-with-appiumprebuiltwdapath" title="Permanent link">&para;</a></h2>
 <p><a href="./">Run Preinstalled WebDriverAgentRunner</a> provides <code>appium:prebuiltWDAPath</code> capability.
 It also achieves the same thing, but the <code>appium:prebuiltWDAPath</code> does not use <code>xcodebuild</code>.
@@ -2276,7 +2280,7 @@ <h2 id="download-prebuilt-wda">Download Prebuilt WDA<a class="headerlink" href="
     <span class="md-icon" title="Last update">
       <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M21 13.1c-.1 0-.3.1-.4.2l-1 1 2.1 2.1 1-1c.2-.2.2-.6 0-.8l-1.3-1.3c-.1-.1-.2-.2-.4-.2m-1.9 1.8-6.1 6V23h2.1l6.1-6.1-2.1-2M12.5 7v5.2l4 2.4-1 1L11 13V7h1.5M11 21.9c-5.1-.5-9-4.8-9-9.9C2 6.5 6.5 2 12 2c5.3 0 9.6 4.1 10 9.3-.3-.1-.6-.2-1-.2s-.7.1-1 .2C19.6 7.2 16.2 4 12 4c-4.4 0-8 3.6-8 8 0 4.1 3.1 7.5 7.1 7.9l-.1.2v1.8Z"/></svg>
     </span>
-    <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-timeago"><span class="timeago" datetime="2024-03-27T16:39:54+00:00" locale="en"></span></span><span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-iso_date">2024-03-27</span>
+    <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-timeago"><span class="timeago" datetime="2024-04-02T16:14:11+00:00" locale="en"></span></span><span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-iso_date">2024-04-02</span>
   </span>
 
 

diff --git a/7.9/reference/capabilities/index.html b/7.9/reference/capabilities/index.html
@@ -2535,8 +2535,13 @@ <h3 id="webdriveragent">WebDriverAgent<a class="headerlink" href="#webdriveragen
 <td><code>8000</code></td>
 </tr>
 <tr>
+<td><code>appium:prebuildWDA</code></td>
+<td>Enables prebuilding if the WebDriverAgentRunner application before running the WDA app. With this capability, XCUITest driver builds the WDA project first, then it handles the session as <code>appium:usePrebuiltWDA</code> <code>true</code> behavior. Defaults to <code>false</code>.</td>
+<td><code>true</code></td>
+</tr>
+<tr>
 <td><code>appium:usePrebuiltWDA</code></td>
-<td>Skips the build phase of running the WDA app. Building is then the responsibility of the user. Only works for Xcode 8+. Defaults to <code>false</code>.</td>
+<td>Skips the build phase of running the WDA app. Building is then the responsibility of the user. <code>appium:derivedDataPath</code> let the session use the path as <code>-derivedDataPath</code> argument for <code>xcodebuild</code> command. Defaults to <code>false</code>.</td>
 <td><code>true</code></td>
 </tr>
 <tr>
@@ -2997,7 +3002,7 @@ <h3 id="other">Other<a class="headerlink" href="#other" title="Permanent link">&
     <span class="md-icon" title="Last update">
       <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M21 13.1c-.1 0-.3.1-.4.2l-1 1 2.1 2.1 1-1c.2-.2.2-.6 0-.8l-1.3-1.3c-.1-.1-.2-.2-.4-.2m-1.9 1.8-6.1 6V23h2.1l6.1-6.1-2.1-2M12.5 7v5.2l4 2.4-1 1L11 13V7h1.5M11 21.9c-5.1-.5-9-4.8-9-9.9C2 6.5 6.5 2 12 2c5.3 0 9.6 4.1 10 9.3-.3-.1-.6-.2-1-.2s-.7.1-1 .2C19.6 7.2 16.2 4 12 4c-4.4 0-8 3.6-8 8 0 4.1 3.1 7.5 7.1 7.9l-.1.2v1.8Z"/></svg>
     </span>
-    <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-timeago"><span class="timeago" datetime="2024-03-31T07:10:31+00:00" locale="en"></span></span><span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-iso_date">2024-03-31</span>
+    <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-timeago"><span class="timeago" datetime="2024-04-02T16:14:11+00:00" locale="en"></span></span><span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-iso_date">2024-04-02</span>
   </span>
 
 

diff --git a/7.9/search/search_index.json b/7.9/search/search_index.json
diff --git a/7.9/sitemap.xml b/7.9/sitemap.xml
@@ -2,192 +2,192 @@
 <urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
     <url>
          <loc>https://appium.github.io/appium-xcuitest-driver/7.9/</loc>
-         <lastmod>2024-03-31</lastmod>
+         <lastmod>2024-04-02</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://appium.github.io/appium-xcuitest-driver/7.9/contributing/</loc>
-         <lastmod>2024-03-31</lastmod>
+         <lastmod>2024-04-02</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://appium.github.io/appium-xcuitest-driver/7.9/endpoints-wda/</loc>
-         <lastmod>2024-03-31</lastmod>
+         <lastmod>2024-04-02</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://appium.github.io/appium-xcuitest-driver/7.9/endpoints/</loc>
-         <lastmod>2024-03-31</lastmod>
+         <lastmod>2024-04-02</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://appium.github.io/appium-xcuitest-driver/7.9/overview/</loc>
-         <lastmod>2024-03-31</lastmod>
+         <lastmod>2024-04-02</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://appium.github.io/appium-xcuitest-driver/7.9/guides/attach-to-running-wda/</loc>
-         <lastmod>2024-03-31</lastmod>
+         <lastmod>2024-04-02</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://appium.github.io/appium-xcuitest-driver/7.9/guides/audio-capture/</loc>
-         <lastmod>2024-03-31</lastmod>
+         <lastmod>2024-04-02</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://appium.github.io/appium-xcuitest-driver/7.9/guides/ci-setup/</loc>
-         <lastmod>2024-03-31</lastmod>
+         <lastmod>2024-04-02</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://appium.github.io/appium-xcuitest-driver/7.9/guides/clipboard/</loc>
-         <lastmod>2024-03-31</lastmod>
+         <lastmod>2024-04-02</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://appium.github.io/appium-xcuitest-driver/7.9/guides/file-transfer/</loc>
-         <lastmod>2024-03-31</lastmod>
+         <lastmod>2024-04-02</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://appium.github.io/appium-xcuitest-driver/7.9/guides/input-events/</loc>
-         <lastmod>2024-03-31</lastmod>
+         <lastmod>2024-04-02</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://appium.github.io/appium-xcuitest-driver/7.9/guides/install-certificate/</loc>
-         <lastmod>2024-03-31</lastmod>
+         <lastmod>2024-04-02</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://appium.github.io/appium-xcuitest-driver/7.9/guides/multiple-xcode-versions/</loc>
-         <lastmod>2024-03-31</lastmod>
+         <lastmod>2024-04-02</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://appium.github.io/appium-xcuitest-driver/7.9/guides/parallel-tests/</loc>
-         <lastmod>2024-03-31</lastmod>
+         <lastmod>2024-04-02</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://appium.github.io/appium-xcuitest-driver/7.9/guides/run-prebuilt-wda/</loc>
-         <lastmod>2024-03-31</lastmod>
+         <lastmod>2024-04-02</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://appium.github.io/appium-xcuitest-driver/7.9/guides/run-preinstalled-wda/</loc>
-         <lastmod>2024-03-31</lastmod>
+         <lastmod>2024-04-02</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://appium.github.io/appium-xcuitest-driver/7.9/guides/touch-id/</loc>
-         <lastmod>2024-03-31</lastmod>
+         <lastmod>2024-04-02</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://appium.github.io/appium-xcuitest-driver/7.9/guides/troubleshooting/</loc>
-         <lastmod>2024-03-31</lastmod>
+         <lastmod>2024-04-02</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://appium.github.io/appium-xcuitest-driver/7.9/guides/tvos/</loc>
-         <lastmod>2024-03-31</lastmod>
+         <lastmod>2024-04-02</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://appium.github.io/appium-xcuitest-driver/7.9/guides/wda-custom-server/</loc>
-         <lastmod>2024-03-31</lastmod>
+         <lastmod>2024-04-02</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://appium.github.io/appium-xcuitest-driver/7.9/installation/</loc>
-         <lastmod>2024-03-31</lastmod>
+         <lastmod>2024-04-02</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://appium.github.io/appium-xcuitest-driver/7.9/installation/requirements/</loc>
-         <lastmod>2024-03-31</lastmod>
+         <lastmod>2024-04-02</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://appium.github.io/appium-xcuitest-driver/7.9/preparation/</loc>
-         <lastmod>2024-03-31</lastmod>
+         <lastmod>2024-04-02</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://appium.github.io/appium-xcuitest-driver/7.9/preparation/prov-profile-basic-auto/</loc>
-         <lastmod>2024-03-31</lastmod>
+         <lastmod>2024-04-02</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://appium.github.io/appium-xcuitest-driver/7.9/preparation/prov-profile-basic-manual/</loc>
-         <lastmod>2024-03-31</lastmod>
+         <lastmod>2024-04-02</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://appium.github.io/appium-xcuitest-driver/7.9/preparation/prov-profile-full-manual/</loc>
-         <lastmod>2024-03-31</lastmod>
+         <lastmod>2024-04-02</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://appium.github.io/appium-xcuitest-driver/7.9/preparation/prov-profile-generic-manual/</loc>
-         <lastmod>2024-03-31</lastmod>
+         <lastmod>2024-04-02</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://appium.github.io/appium-xcuitest-driver/7.9/preparation/real-device-config/</loc>
-         <lastmod>2024-03-31</lastmod>
+         <lastmod>2024-04-02</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://appium.github.io/appium-xcuitest-driver/7.9/reference/capabilities/</loc>
-         <lastmod>2024-03-31</lastmod>
+         <lastmod>2024-04-02</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://appium.github.io/appium-xcuitest-driver/7.9/reference/commands/</loc>
-         <lastmod>2024-03-31</lastmod>
+         <lastmod>2024-04-02</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://appium.github.io/appium-xcuitest-driver/7.9/reference/element-attributes/</loc>
-         <lastmod>2024-03-31</lastmod>
+         <lastmod>2024-04-02</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://appium.github.io/appium-xcuitest-driver/7.9/reference/execute-methods/</loc>
-         <lastmod>2024-03-31</lastmod>
+         <lastmod>2024-04-02</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://appium.github.io/appium-xcuitest-driver/7.9/reference/ios-predicate/</loc>
-         <lastmod>2024-03-31</lastmod>
+         <lastmod>2024-04-02</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://appium.github.io/appium-xcuitest-driver/7.9/reference/locator-strategies/</loc>
-         <lastmod>2024-03-31</lastmod>
+         <lastmod>2024-04-02</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://appium.github.io/appium-xcuitest-driver/7.9/reference/scripts/</loc>
-         <lastmod>2024-03-31</lastmod>
+         <lastmod>2024-04-02</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://appium.github.io/appium-xcuitest-driver/7.9/reference/security-flags/</loc>
-         <lastmod>2024-03-31</lastmod>
+         <lastmod>2024-04-02</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://appium.github.io/appium-xcuitest-driver/7.9/reference/server-args/</loc>
-         <lastmod>2024-03-31</lastmod>
+         <lastmod>2024-04-02</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://appium.github.io/appium-xcuitest-driver/7.9/reference/settings/</loc>
-         <lastmod>2024-03-31</lastmod>
+         <lastmod>2024-04-02</lastmod>
          <changefreq>daily</changefreq>
     </url>
 </urlset>
diff --git a/7.9/sitemap.xml.gz b/7.9/sitemap.xml.gz