Deployed 4660fbc with MkDocs version: 1.4.2

slackhq · Aug 10, 2023 · cea74d4 · cea74d4
1 parent 69870cd
commit cea74d4
Show file tree

Hide file tree

Showing 8 changed files with 155 additions and 20 deletions.
diff --git a/api/0.x/scripts/pages.json b/api/0.x/scripts/pages.json
diff --git a/api/0.x/slack-plugin/slack.gradle/-android-features-handler/index.html b/api/0.x/slack-plugin/slack.gradle/-android-features-handler/index.html
@@ -94,6 +94,21 @@ <h2 class="">Functions</h2>
               </div>
             </div>
           </div>
+<a data-name="-1072977499%2FFunctions%2F-2134763016" anchor-label="resources" id="-1072977499%2FFunctions%2F-2134763016" data-filterable-set=":slack-plugin:dokkaHtmlPartial/main"></a>
+          <div class="table-row" data-filterable-current=":slack-plugin:dokkaHtmlPartial/main" data-filterable-set=":slack-plugin:dokkaHtmlPartial/main">
+            <div class="main-subrow keyValue ">
+              <div class=""><span class="inline-flex">
+                  <div><a href="resources.html"><span><span>resources</span></span></a></div>
+<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1072977499%2FFunctions%2F-2134763016"></span>
+                    <div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
+                  </span></span></div>
+              <div>
+                <div class="title">
+                  <div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":slack-plugin:dokkaHtmlPartial/main"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">fun </span><a href="resources.html"><span class="token function">resources</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">prefix<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></span></span><span class="token punctuation">)</span></div><div class="brief "><p class="paragraph"><strong>LIBRARIES ONLY</strong></p></div></div></div>
+                </div>
+              </div>
+            </div>
+          </div>
 <a data-name="252898028%2FFunctions%2F-2134763016" anchor-label="robolectric" id="252898028%2FFunctions%2F-2134763016" data-filterable-set=":slack-plugin:dokkaHtmlPartial/main"></a>
           <div class="table-row" data-filterable-current=":slack-plugin:dokkaHtmlPartial/main" data-filterable-set=":slack-plugin:dokkaHtmlPartial/main">
             <div class="main-subrow keyValue ">

diff --git a/api/0.x/slack-plugin/slack.gradle/-android-features-handler/resources.html b/api/0.x/slack-plugin/slack.gradle/-android-features-handler/resources.html
@@ -0,0 +1,66 @@
+<!doctype html>
+<html>
+<head>
+    <meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
+    <title>resources</title>
+<link href="../../../images/logo-icon.svg" rel="icon" type="image/svg"><script>var pathToRoot = "../../../";</script>    <script>const storage = localStorage.getItem("dokka-dark-mode")
+    if (storage == null) {
+        const osDarkSchemePreferred = window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches
+        if (osDarkSchemePreferred === true) {
+            document.getElementsByTagName("html")[0].classList.add("theme-dark")
+        }
+    } else {
+        const savedDarkMode = JSON.parse(storage)
+        if(savedDarkMode === true) {
+            document.getElementsByTagName("html")[0].classList.add("theme-dark")
+        }
+    }
+    </script>
+<script type="text/javascript" src="../../../scripts/sourceset_dependencies.js" async></script>
+<link href="../../../styles/style.css" rel="Stylesheet">
+<link href="../../../styles/jetbrains-mono.css" rel="Stylesheet">
+<link href="../../../styles/main.css" rel="Stylesheet">
+<link href="../../../styles/prism.css" rel="Stylesheet">
+<link href="../../../styles/logo-styles.css" rel="Stylesheet">
+<script type="text/javascript" src="../../../scripts/clipboard.js" async></script>
+<script type="text/javascript" src="../../../scripts/navigation-loader.js" async></script>
+<script type="text/javascript" src="../../../scripts/platform-content-handler.js" async></script>
+<script type="text/javascript" src="../../../scripts/main.js" defer></script>
+<script type="text/javascript" src="../../../scripts/prism.js" async></script>
+<script type="text/javascript" src="../../../scripts/symbol-parameters-wrapper_deferred.js" defer></script></head>
+<body>
+<div class="navigation-wrapper" id="navigation-wrapper">
+    <div id="leftToggler"><span class="icon-toggler"></span></div>
+    <div class="library-name">
+<a href="../../../index.html">
+<span>slack-gradle-plugin</span>            </a>    </div>
+    <div>
+    </div>
+    <div class="pull-right d-flex">
+        <div class="filter-section" id="filter-section">
+                <button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":slack-plugin:dokkaHtmlPartial/main">jvm</button>
+        </div>
+        <button id="theme-toggle-button"><span id="theme-toggle"></span></button>
+        <div id="searchBar"></div>
+    </div>
+</div>
+<div id="container">
+    <div id="leftColumn">
+        <div id="sideMenu"></div>
+    </div>
+    <div id="main">
+<div class="main-content" data-page-type="member" id="content" pageids="slack-plugin::slack.gradle/AndroidFeaturesHandler/resources/#kotlin.String/PointingToDeclaration//-2134763016">
+  <div class="breadcrumbs"><a href="../../index.html">slack-plugin</a><span class="delimiter">/</span><a href="../index.html">slack.gradle</a><span class="delimiter">/</span><a href="index.html">AndroidFeaturesHandler</a><span class="delimiter">/</span><span class="current">resources</span></div>
+  <div class="cover ">
+    <h1 class="cover"><span><span>resources</span></span></h1>
+  </div>
+  <div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":slack-plugin:dokkaHtmlPartial/main"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">fun </span><a href="resources.html"><span class="token function">resources</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">prefix<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></span></span><span class="token punctuation">)</span></div><p class="paragraph"><strong>LIBRARIES ONLY</strong></p><p class="paragraph">Enables android resources in this library and enforces use of the given <a href="resources.html">prefix</a> for all resources.</p></div></div>
+</div>
+      <div class="footer">
+        <span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2023 Copyright</span><span class="pull-right"><span>Generated by </span><a href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
+      </div>
+    </div>
+</div>
+</body>
+</html>
+
diff --git a/changelog/index.html b/changelog/index.html
@@ -378,6 +378,13 @@
     </label>
     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
 
+        <li class="md-nav__item">
+  <a href="#0104" class="md-nav__link">
+    0.10.4
+  </a>
+
+</li>
+
         <li class="md-nav__item">
   <a href="#0103" class="md-nav__link">
     0.10.3
@@ -1009,6 +1016,13 @@
     </label>
     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
 
+        <li class="md-nav__item">
+  <a href="#0104" class="md-nav__link">
+    0.10.4
+  </a>
+
+</li>
+
         <li class="md-nav__item">
   <a href="#0103" class="md-nav__link">
     0.10.3
@@ -1580,6 +1594,29 @@
 
 
 <h1 id="changelog">Changelog<a class="headerlink" href="#changelog" title="Permanent link">&para;</a></h1>
+<h2 id="0104">0.10.4<a class="headerlink" href="#0104" title="Permanent link">&para;</a></h2>
+<p><em>2023-08-10</em></p>
+<ul>
+<li><strong>New</strong>: New DSL API for enabling Android resources.</li>
+</ul>
+<p>This streamlines configuration of enabling <code>androidResources</code> and enforces use of a resource prefix to avoid conflicts.</p>
+<p>May your avatars never be wrongly sized again.</p>
+<div class="highlight"><pre><span></span><code><span class="n">slack</span><span class="w"> </span><span class="p">{</span>
+<span class="w">  </span><span class="n">android</span><span class="w"> </span><span class="p">{</span>
+<span class="w">    </span><span class="n">features</span><span class="w"> </span><span class="p">{</span>
+<span class="w">      </span><span class="n">resources</span><span class="p">(</span><span class="s">&quot;prefix_&quot;</span><span class="p">)</span>
+<span class="w">    </span><span class="p">}</span>
+<span class="w">  </span><span class="p">}</span>
+<span class="p">}</span>
+</code></pre></div>
+<ul>
+<li>Update kotlin-cli-util to <code>2.0.0</code>.</li>
+<li>Update Moshi to <code>1.15.0</code>.</li>
+<li>Update sort-dependencies to <code>0.4</code>.</li>
+<li>Update KSP to <code>1.9.0-1.0.13</code>.</li>
+<li>Update Okio to <code>3.5.0</code>.</li>
+<li>Update Jetbrains Markdown to <code>0.5.0</code>.</li>
+</ul>
 <h2 id="0103">0.10.3<a class="headerlink" href="#0103" title="Permanent link">&para;</a></h2>
 <p><em>2023-08-08</em></p>
 <ul>

diff --git a/dsl/index.html b/dsl/index.html
@@ -394,6 +394,13 @@
     Android Test
   </a>
 
+</li>
+
+          <li class="md-nav__item">
+  <a href="#resources" class="md-nav__link">
+    Resources
+  </a>
+
 </li>
 
       </ul>
@@ -606,6 +613,13 @@
     Android Test
   </a>
 
+</li>
+
+          <li class="md-nav__item">
+  <a href="#resources" class="md-nav__link">
+    Resources
+  </a>
+
 </li>
 
       </ul>
@@ -695,6 +709,9 @@ <h3 id="robolectric">Robolectric<a class="headerlink" href="#robolectric" title=
 <h3 id="android-test">Android Test<a class="headerlink" href="#android-test" title="Permanent link">&para;</a></h3>
 <p>By default, SGP disables androidTests in projects. These can be enabled via the <code>androidTest()</code> feature, which will enable the relevant controls in the Android plugin. This can also accept specified variants to enable/disable.</p>
 <p>This is important for opting in tests to <a href="/utilities/#androidtest-apk-aggregation">AndroidTest APK Aggregation</a>.</p>
+<h3 id="resources">Resources<a class="headerlink" href="#resources" title="Permanent link">&para;</a></h3>
+<p>By default, we disable <em>Android</em> resources (different from <em>Java</em> resources) and libraries have to opt-in to using them.</p>
+<p>This can be enabled via the <code>resources()</code> feature, which will enable the relevant <code>BuildFeature</code> in the Android plugin and also takes a required <code>prefix</code> parameter that is used as the required <code>resourcePrefix</code> for that library&rsquo;s resources to avoid naming conflicts.</p>
 <h2 id="android-application-features">Android Application Features<a class="headerlink" href="#android-application-features" title="Permanent link">&para;</a></h2>
 <h3 id="permission-allowlist">Permission AllowList<a class="headerlink" href="#permission-allowlist" title="Permanent link">&para;</a></h3>
 <p>This enables checking of a permission allowlist. See <a href="/utilities/#permissionchecks"><code>PermissionChecks</code></a> for more

diff --git a/search/search_index.json b/search/search_index.json
diff --git a/sitemap.xml b/sitemap.xml
@@ -2,92 +2,92 @@
 <urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
     <url>
          <loc>None</loc>
-         <lastmod>2023-08-08</lastmod>
+         <lastmod>2023-08-10</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>None</loc>
-         <lastmod>2023-08-08</lastmod>
+         <lastmod>2023-08-10</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>None</loc>
-         <lastmod>2023-08-08</lastmod>
+         <lastmod>2023-08-10</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>None</loc>
-         <lastmod>2023-08-08</lastmod>
+         <lastmod>2023-08-10</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>None</loc>
-         <lastmod>2023-08-08</lastmod>
+         <lastmod>2023-08-10</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>None</loc>
-         <lastmod>2023-08-08</lastmod>
+         <lastmod>2023-08-10</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>None</loc>
-         <lastmod>2023-08-08</lastmod>
+         <lastmod>2023-08-10</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>None</loc>
-         <lastmod>2023-08-08</lastmod>
+         <lastmod>2023-08-10</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>None</loc>
-         <lastmod>2023-08-08</lastmod>
+         <lastmod>2023-08-10</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>None</loc>
-         <lastmod>2023-08-08</lastmod>
+         <lastmod>2023-08-10</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>None</loc>
-         <lastmod>2023-08-08</lastmod>
+         <lastmod>2023-08-10</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>None</loc>
-         <lastmod>2023-08-08</lastmod>
+         <lastmod>2023-08-10</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>None</loc>
-         <lastmod>2023-08-08</lastmod>
+         <lastmod>2023-08-10</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>None</loc>
-         <lastmod>2023-08-08</lastmod>
+         <lastmod>2023-08-10</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>None</loc>
-         <lastmod>2023-08-08</lastmod>
+         <lastmod>2023-08-10</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>None</loc>
-         <lastmod>2023-08-08</lastmod>
+         <lastmod>2023-08-10</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>None</loc>
-         <lastmod>2023-08-08</lastmod>
+         <lastmod>2023-08-10</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>None</loc>
-         <lastmod>2023-08-08</lastmod>
+         <lastmod>2023-08-10</lastmod>
          <changefreq>daily</changefreq>
     </url>
 </urlset>
diff --git a/sitemap.xml.gz b/sitemap.xml.gz