docs: add a link to snapcraft authentication options for cd in snap.md (

#7814)
electron-userland · Oct 19, 2023 · 549d07b · 549d07b
1 parent f2a1f1e
commit 549d07b
Show file tree

Hide file tree

Showing 4 changed files with 13 additions and 3 deletions.
diff --git a/.changeset/modern-dingos-sing.md b/.changeset/modern-dingos-sing.md
@@ -0,0 +1,6 @@
+---
+"app-builder-lib": patch
+"builder-util-runtime": patch
+---
+
+minor addition to docs for snap publishing. add snapcraft link to local and cd auth options
diff --git a/docs/configuration/publish.md b/docs/configuration/publish.md
@@ -190,7 +190,9 @@ Define <code>GH_TOKEN</code> environment variable.</p>
 </li>
 </ul>
 <h2 id="snapstoreoptions">SnapStoreOptions</h2>
-<p><a href="https://snapcraft.io/">Snap Store</a> options.</p>
+<p><a href="https://snapcraft.io/">Snap Store</a> options. To publish directly to Snapcraft,
+see <a href="https://snapcraft.io/docs/snapcraft-authentication">Snapcraft
+authentication options</a> for local or CI/CD authentication options.</p>
 <ul>
 <li><strong><code id="SnapStoreOptions-provider">provider</code></strong> “snapStore” - The provider. Must be <code>snapStore</code>.</li>
 <li><code id="SnapStoreOptions-repo">repo</code> String - snapcraft repo name</li>

diff --git a/packages/app-builder-lib/scheme.json b/packages/app-builder-lib/scheme.json
@@ -5624,7 +5624,7 @@
           "description": "The list of channels the snap would be released."
         },
         "provider": {
-          "description": "The provider. Must be `snapStore`.",
+          "description": "The provider. Must be `snapStore`. To publish directly to Snapcraft,\n see <a href=\"https://snapcraft.io/docs/snapcraft-authentication\">Snapcraft\n authentication options</a> for local or CI/CD authentication options.",
           "enum": [
             "snapStore"
           ],

diff --git a/packages/builder-util-runtime/src/publishOptions.ts b/packages/builder-util-runtime/src/publishOptions.ts
@@ -248,7 +248,9 @@ export interface BitbucketOptions extends PublishConfiguration {
 }
 
 /**
- * [Snap Store](https://snapcraft.io/) options.
+ * [Snap Store](https://snapcraft.io/) options. To publish directly to Snapcraft,
+ *  see <a href="https://snapcraft.io/docs/snapcraft-authentication">Snapcraft
+ *  authentication options</a> for local or CI/CD authentication options.
  */
 export interface SnapStoreOptions extends PublishConfiguration {
   /**