diff --git a/.changes/pr255.md b/.changes/pr255.md new file mode 100644 index 00000000..b08dba44 --- /dev/null +++ b/.changes/pr255.md @@ -0,0 +1,11 @@ +--- +"cargo-packager": "patch" +"@crabnebula/packager": "patch" +--- + +Explicitly mention which fields in `Config` and other configuration structs +are skipped during deserialization. +This reduces confusion for new users looking at the docs for `Config`, +who may receive unexpected errors when attempting to specify skipped fields +in their config files or Cargo package metadata. + diff --git a/crates/packager/src/config/mod.rs b/crates/packager/src/config/mod.rs index 1a022b2c..e961ea25 100644 --- a/crates/packager/src/config/mod.rs +++ b/crates/packager/src/config/mod.rs @@ -624,15 +624,23 @@ pub struct MacOsConfig { #[serde(alias = "exception-domain", alias = "exception_domain")] pub exception_domain: Option, /// Code signing identity. + /// + /// This is typically of the form: `"Developer ID Application: TEAM_NAME (TEAM_ID)"`. #[serde(alias = "signing-identity", alias = "signing_identity")] pub signing_identity: Option, /// Codesign certificate (base64 encoded of the p12 file). + /// + /// Note: this field cannot be specified via a config file or Cargo package metadata. #[serde(skip)] pub signing_certificate: Option, /// Password of the codesign certificate. + /// + /// Note: this field cannot be specified via a config file or Cargo package metadata. #[serde(skip)] pub signing_certificate_password: Option, /// Notarization authentication credentials. + /// + /// Note: this field cannot be specified via a config file or Cargo package metadata. #[serde(skip)] pub notarization_credentials: Option, /// Provider short name for notarization.