Skip to content

Commit

Permalink
docs: add a link to snapcraft authentication options for cd in snap.md (
Browse files Browse the repository at this point in the history
  • Loading branch information
jgresham authored Oct 19, 2023
1 parent f2a1f1e commit 549d07b
Show file tree
Hide file tree
Showing 4 changed files with 13 additions and 3 deletions.
6 changes: 6 additions & 0 deletions .changeset/modern-dingos-sing.md
Original file line number Diff line number Diff line change
@@ -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
4 changes: 3 additions & 1 deletion docs/configuration/publish.md
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down
2 changes: 1 addition & 1 deletion packages/app-builder-lib/scheme.json
Original file line number Diff line number Diff line change
Expand Up @@ -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"
],
Expand Down
4 changes: 3 additions & 1 deletion packages/builder-util-runtime/src/publishOptions.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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 {
/**
Expand Down

0 comments on commit 549d07b

Please sign in to comment.