Skip to content

docs: remove stale --osx-sign.entitlements CLI options from usage.txt#1932

Open
claude[bot] wants to merge 1 commit into
mainfrom
docs/osx-sign-entitlements-usage
Open

docs: remove stale --osx-sign.entitlements CLI options from usage.txt#1932
claude[bot] wants to merge 1 commit into
mainfrom
docs/osx-sign-entitlements-usage

Conversation

@claude

@claude claude Bot commented Jul 3, 2026

Copy link
Copy Markdown
Contributor

Requested by Samuel Attard · Slack thread

  • I have read the contribution documentation for this project.
  • I agree to follow the code of conduct that this project follows, as appropriate.
  • The changes are appropriately documented (if applicable).
  • The changes have sufficient test coverage (if applicable). (N/A — help-text-only change)
  • The testsuite passes successfully on my local machine (if applicable). (yarn lint passes; no code changes)

Summarize your changes:

Before: --help (via usage.txt) promised that --osx-sign.entitlements and --osx-sign.entitlements-inherit could be used to set signing entitlements from the CLI. In reality, since @electron/osx-sign >= 1.0 these flags are silently ignored and the default entitlements are used instead: per-file signing options such as entitlements can only be supplied through an optionsForFile function on the sign options, which the CLI's dot-notation cannot express (and entitlements-inherit no longer exists as an option at all).

After: the help text no longer advertises the non-functional flags. It keeps the working identity example and adds a note that per-file signing options such as custom entitlements cannot be set from the CLI, pointing users to the JavaScript API's osxSign.optionsForFile function and the @electron/osx-sign docs.

No other docs make the same stale claim (README, docs/, and JSDoc were checked); the binaries JSDoc inaccuracy in src/types.ts is tracked separately in #1723.

Fixes #1854

🤖 Generated with Claude Code

https://claude.ai/code/session_01Gjy8Kvb56YvEgBhhGEqeNF


Generated by Claude Code

@claude claude Bot force-pushed the docs/osx-sign-entitlements-usage branch from 8163e39 to af9ef2d Compare July 3, 2026 19:49
@MarshallOfSound MarshallOfSound marked this pull request as ready for review July 3, 2026 19:58
@MarshallOfSound MarshallOfSound requested a review from a team as a code owner July 3, 2026 19:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Impedance mismatch between packager and osx-sign w.r.t. entitlements

2 participants