search

crabnebula-dev / cargo-packager

Rust executable packager, bundler and updater.
https://docs.crabnebula.dev/packager/
Apache License 2.0
241 stars 16 forks source link

docs(macos): explicitly mention which fields are skipped #255

Closed kevinaboos closed 3 months ago

kevinaboos commented 3 months ago

New users may be confused when looking at the docs for Config and other config-like structs, as some fields cannot be specified in config files or via Cargo's package metadata. This commit clarifies that those fields are intentionally excluded.

Also added an example of a macOS developer signing identity.

Notes

I added this notice to the docs of only 3 fields, those that were annotated with #[serde(skip)]. Let me know if there are any other fields that should have this notice too.

denjell-crabnebula commented 3 months ago

I approved the workflows because this is non-controversial. Still need @lucasfernog-crabnebula or @amr-crabnebula to approve.

kevinaboos commented 3 months ago

nice catch, thanks we skip because those are secrets so they should be defined programatically or via env vars

Thanks, yeah I should've mentioned it here, but for the sake of giving credit, Amr is the one who informed me of this originally: https://github.com/crabnebula-dev/cargo-packager/pull/246#issuecomment-2187715953