Skip to content

Commit a12eb59

Browse files
committed
Update schema properly
1 parent 201a3ed commit a12eb59

4 files changed

Lines changed: 17 additions & 8 deletions

File tree

CONSTRUCT.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -235,6 +235,7 @@ The type of the installer being created. Possible values are:
235235
- `sh`: shell-based installer for Linux or macOS
236236
- `pkg`: macOS GUI installer built with Apple's `pkgbuild`
237237
- `exe`: Windows GUI installer built with NSIS
238+
- `msi`: Windows GUI installer built with Briefcase and WiX
238239

239240
The default type is `sh` on Linux and macOS, and `exe` on Windows. A special
240241
value of `all` builds _both_ `sh` and `pkg` installers on macOS, as well
@@ -317,8 +318,11 @@ Name of the company/entity responsible for the installer.
317318
### `reverse_domain_identifier`
318319

319320
Unique identifier for this package, formatted with reverse domain notation. This is
320-
used internally in the PKG installers to handle future updates and others. If not
321-
provided, it will default to `io.continuum`. (MacOS only)
321+
used internally in the MSI and PKG installers to handle future updates and others.
322+
If not provided, it will default to:
323+
324+
* In MSI installers: `io.continuum` followed by an ID derived from the `name`.
325+
* In PKG installers: `io.continuum`.
322326

323327
### `uninstall_name`
324328

constructor/_schema.py

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,7 @@ class WinSignTools(StrEnum):
4040
class InstallerTypes(StrEnum):
4141
ALL = "all"
4242
EXE = "exe"
43+
MSI = "msi"
4344
PKG = "pkg"
4445
SH = "sh"
4546

@@ -401,6 +402,7 @@ class ConstructorConfiguration(BaseModel):
401402
- `sh`: shell-based installer for Linux or macOS
402403
- `pkg`: macOS GUI installer built with Apple's `pkgbuild`
403404
- `exe`: Windows GUI installer built with NSIS
405+
- `msi`: Windows GUI installer built with Briefcase and WiX
404406
405407
The default type is `sh` on Linux and macOS, and `exe` on Windows. A special
406408
value of `all` builds _both_ `sh` and `pkg` installers on macOS, as well
@@ -484,8 +486,11 @@ class ConstructorConfiguration(BaseModel):
484486
reverse_domain_identifier: NonEmptyStr | None = None
485487
"""
486488
Unique identifier for this package, formatted with reverse domain notation. This is
487-
used internally in the PKG installers to handle future updates and others. If not
488-
provided, it will default to `io.continuum`. (MacOS only)
489+
used internally in the MSI and PKG installers to handle future updates and others.
490+
If not provided, it will default to:
491+
492+
* In MSI installers: `io.continuum` followed by an ID derived from the `name`.
493+
* In PKG installers: `io.continuum`.
489494
"""
490495
uninstall_name: NonEmptyStr | None = None
491496
"""

constructor/data/construct.schema.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -825,7 +825,7 @@
825825
}
826826
],
827827
"default": null,
828-
"description": "The type of the installer being created. Possible values are:\n- `sh`: shell-based installer for Linux or macOS\n- `pkg`: macOS GUI installer built with Apple's `pkgbuild`\n- `exe`: Windows GUI installer built with NSIS\nThe default type is `sh` on Linux and macOS, and `exe` on Windows. A special value of `all` builds _both_ `sh` and `pkg` installers on macOS, as well as `sh` on Linux and `exe` on Windows.",
828+
"description": "The type of the installer being created. Possible values are:\n- `sh`: shell-based installer for Linux or macOS\n- `pkg`: macOS GUI installer built with Apple's `pkgbuild`\n- `exe`: Windows GUI installer built with NSIS\n- `msi`: Windows GUI installer built with Briefcase and WiX\nThe default type is `sh` on Linux and macOS, and `exe` on Windows. A special value of `all` builds _both_ `sh` and `pkg` installers on macOS, as well as `sh` on Linux and `exe` on Windows.",
829829
"title": "Installer Type"
830830
},
831831
"keep_pkgs": {
@@ -1105,7 +1105,7 @@
11051105
}
11061106
],
11071107
"default": null,
1108-
"description": "Unique identifier for this package, formatted with reverse domain notation. This is used internally in the PKG installers to handle future updates and others. If not provided, it will default to `io.continuum`. (MacOS only)",
1108+
"description": "Unique identifier for this package, formatted with reverse domain notation. This is used internally in the MSI and PKG installers to handle future updates and others. If not provided, it will default to:\n* In MSI installers: `io.continuum` followed by an ID derived from the `name`. * In PKG installers: `io.continuum`.",
11091109
"title": "Reverse Domain Identifier"
11101110
},
11111111
"script_env_variables": {

docs/source/construct-yaml.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -318,8 +318,8 @@ Name of the company/entity responsible for the installer.
318318
### `reverse_domain_identifier`
319319

320320
Unique identifier for this package, formatted with reverse domain notation. This is
321-
used internally in the MSI and PKG installers to handle future updates and others. If
322-
not provided, it will default to:
321+
used internally in the MSI and PKG installers to handle future updates and others.
322+
If not provided, it will default to:
323323

324324
* In MSI installers: `io.continuum` followed by an ID derived from the `name`.
325325
* In PKG installers: `io.continuum`.

0 commit comments

Comments
 (0)