Skip to content

Commit

Permalink
fix: SnapStoreOptions required properties (#6327) (#6333)
Browse files Browse the repository at this point in the history
  • Loading branch information
lutzroeder committed Oct 13, 2021
1 parent 2326bf1 commit 54ee4e7
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 5 deletions.
7 changes: 7 additions & 0 deletions .changeset/chatty-yaks-cover.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
"app-builder-lib": patch
"builder-util-runtime": patch
"builder-util": patch
---

fix: SnapStoreOptions required properties (#6327)
12 changes: 8 additions & 4 deletions packages/app-builder-lib/scheme.json
Original file line number Diff line number Diff line change
Expand Up @@ -446,7 +446,7 @@
},
"BitbucketOptions": {
"additionalProperties": false,
"description": "Bitbucket options.\nhttps://keygen.sh/\nDefine `BITBUCKET_TOKEN` environment variable.",
"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```",
"properties": {
"channel": {
"default": "latest",
Expand Down Expand Up @@ -643,7 +643,7 @@
"type": "null"
}
],
"description": "Package dependencies. Defaults to `[\"gconf2\", \"gconf-service\", \"libnotify4\", \"libappindicator1\", \"libxtst6\", \"libnss3\"]`."
"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)."
},
"description": {
"description": "As [description](/configuration/configuration#Metadata-description) from application package.json, but allows you to specify different for Linux.",
Expand Down Expand Up @@ -3603,6 +3603,10 @@
"description": "Whether to create start menu shortcut.",
"type": "boolean"
},
"iconId": {
"description": "The [shortcut iconId](https://wixtoolset.org/documentation/manual/v4/reference/wxs/shortcut/). Optional, by default generated using app file name.",
"type": "string"
},
"menuCategory": {
"default": false,
"description": "Whether to create submenu for start menu shortcut and program files directory. If `true`, company name will be used. Or string value.",
Expand Down Expand Up @@ -4893,6 +4897,7 @@
},
"S3Options": {
"additionalProperties": false,
"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```",
"properties": {
"acl": {
"anyOf": [
Expand Down Expand Up @@ -5445,8 +5450,7 @@
}
},
"required": [
"provider",
"repo"
"provider"
],
"type": "object"
},
Expand Down
2 changes: 1 addition & 1 deletion packages/builder-util-runtime/src/publishOptions.ts
Original file line number Diff line number Diff line change
Expand Up @@ -237,7 +237,7 @@ export interface SnapStoreOptions extends PublishConfiguration {
/**
* snapcraft repo name
*/
readonly repo: string
readonly repo?: string

/**
* The list of channels the snap would be released.
Expand Down

0 comments on commit 54ee4e7

Please sign in to comment.