Skip to content

Commit 54ee4e7

Browse files
authored
fix: SnapStoreOptions required properties (#6327) (#6333)
1 parent 2326bf1 commit 54ee4e7

File tree

3 files changed

+16
-5
lines changed

3 files changed

+16
-5
lines changed

.changeset/chatty-yaks-cover.md

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
"app-builder-lib": patch
3+
"builder-util-runtime": patch
4+
"builder-util": patch
5+
---
6+
7+
fix: SnapStoreOptions required properties (#6327)

packages/app-builder-lib/scheme.json

+8-4
Original file line numberDiff line numberDiff line change
@@ -446,7 +446,7 @@
446446
},
447447
"BitbucketOptions": {
448448
"additionalProperties": false,
449-
"description": "Bitbucket options.\nhttps://keygen.sh/\nDefine `BITBUCKET_TOKEN` environment variable.",
449+
"description": "Bitbucket options.\nhttps://bitbucket.org/\nDefine `BITBUCKET_TOKEN` environment variable.\n\nFor converting an app password to a usable token, you can utilize this\n```typescript\nconvertAppPassword(owner: string, token: string) {\nconst base64encodedData = Buffer.from(`${owner}:${token.trim()}`).toString(\"base64\")\nreturn `Basic ${base64encodedData}`\n}\n```",
450450
"properties": {
451451
"channel": {
452452
"default": "latest",
@@ -643,7 +643,7 @@
643643
"type": "null"
644644
}
645645
],
646-
"description": "Package dependencies. Defaults to `[\"gconf2\", \"gconf-service\", \"libnotify4\", \"libappindicator1\", \"libxtst6\", \"libnss3\"]`."
646+
"description": "Package dependencies. Defaults to `[\"gconf2\", \"gconf-service\", \"libnotify4\", \"libappindicator1\", \"libxtst6\", \"libnss3\"]`.\nIf need to support Debian, `libappindicator1` should be removed, it is [deprecated in Debian](https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=895037).\nIf need to support KDE, `gconf2` and `gconf-service` should be removed as it's no longer used by GNOME](https://packages.debian.org/bullseye/gconf2)."
647647
},
648648
"description": {
649649
"description": "As [description](/configuration/configuration#Metadata-description) from application package.json, but allows you to specify different for Linux.",
@@ -3603,6 +3603,10 @@
36033603
"description": "Whether to create start menu shortcut.",
36043604
"type": "boolean"
36053605
},
3606+
"iconId": {
3607+
"description": "The [shortcut iconId](https://wixtoolset.org/documentation/manual/v4/reference/wxs/shortcut/). Optional, by default generated using app file name.",
3608+
"type": "string"
3609+
},
36063610
"menuCategory": {
36073611
"default": false,
36083612
"description": "Whether to create submenu for start menu shortcut and program files directory. If `true`, company name will be used. Or string value.",
@@ -4893,6 +4897,7 @@
48934897
},
48944898
"S3Options": {
48954899
"additionalProperties": false,
4900+
"description": "[Amazon S3](https://aws.amazon.com/s3/) options.\nAWS credentials are required, please see [getting your credentials](http://docs.aws.amazon.com/sdk-for-javascript/v2/developer-guide/getting-your-credentials.html).\nDefine `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY` [environment variables](http://docs.aws.amazon.com/sdk-for-javascript/v2/developer-guide/loading-node-credentials-environment.html).\nOr in the [~/.aws/credentials](http://docs.aws.amazon.com/sdk-for-javascript/v2/developer-guide/loading-node-credentials-shared.html).\n\nExample configuration:\n\n```json\n{\n\"build\":\n \"publish\": {\n \"provider\": \"s3\",\n \"bucket\": \"bucket-name\"\n }\n}\n}\n```",
48964901
"properties": {
48974902
"acl": {
48984903
"anyOf": [
@@ -5445,8 +5450,7 @@
54455450
}
54465451
},
54475452
"required": [
5448-
"provider",
5449-
"repo"
5453+
"provider"
54505454
],
54515455
"type": "object"
54525456
},

packages/builder-util-runtime/src/publishOptions.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -237,7 +237,7 @@ export interface SnapStoreOptions extends PublishConfiguration {
237237
/**
238238
* snapcraft repo name
239239
*/
240-
readonly repo: string
240+
readonly repo?: string
241241

242242
/**
243243
* The list of channels the snap would be released.

0 commit comments

Comments
 (0)