Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(docs): fixing strikethrough text #8497

Merged
merged 1 commit into from
Sep 18, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,11 @@ markdown_extensions:
- pymdownx.details
- pymdownx.inlinehilite
- pymdownx.superfences
- pymdownx.critic
- pymdownx.caret
- pymdownx.keys
- pymdownx.mark
- pymdownx.tilde
- toc:
permalink: true
- markdown_include.include:
Expand Down
20 changes: 10 additions & 10 deletions packages/app-builder-lib/src/options/winOptions.ts
Original file line number Diff line number Diff line change
Expand Up @@ -25,58 +25,58 @@ export interface WindowsConfiguration extends PlatformSpecificBuildOptions {

/**
* Array of signing algorithms used. For AppX `sha256` is always used.
* @deprecated Please use {@link signtoolOptions.signingHashAlgorithms}
* @deprecated Please use {@link signtoolOptions}: {@link WindowsSigntoolConfiguration.signingHashAlgorithms}
*/
readonly signingHashAlgorithms?: Array<"sha1" | "sha256"> | null
/**
* The custom function (or path to file or module id) to sign Windows executables
* @deprecated Please use {@link signtoolOptions.sign}
* @deprecated Please use {@link signtoolOptions}: {@link WindowsSigntoolConfiguration.sign}
*/
readonly sign?: CustomWindowsSign | string | null
/**
* The path to the *.pfx certificate you want to sign with. Please use it only if you cannot use env variable `CSC_LINK` (`WIN_CSC_LINK`) for some reason.
* Please see [Code Signing](./code-signing.md).
* @deprecated Please use {@link signtoolOptions.certificateFile}
* @deprecated Please use {@link signtoolOptions}: {@link WindowsSigntoolConfiguration.certificateFile}
*/
readonly certificateFile?: string | null
/**
* The password to the certificate provided in `certificateFile`. Please use it only if you cannot use env variable `CSC_KEY_PASSWORD` (`WIN_CSC_KEY_PASSWORD`) for some reason.
* Please see [Code Signing](./code-signing.md).
* @deprecated Please use {@link signtoolOptions.certificatePassword}
* @deprecated Please use {@link signtoolOptions}: {@link WindowsSigntoolConfiguration.certificatePassword}
*/
readonly certificatePassword?: string | null
/**
* The name of the subject of the signing certificate, which is often labeled with the field name `issued to`. Required only for EV Code Signing and works only on Windows (or on macOS if [Parallels Desktop](https://www.parallels.com/products/desktop/) Windows 10 virtual machines exits).
* @deprecated Please use {@link signtoolOptions.certificateSubjectName}
* @deprecated Please use {@link signtoolOptions}: {@link WindowsSigntoolConfiguration.certificateSubjectName}
*/
readonly certificateSubjectName?: string | null
/**
* The SHA1 hash of the signing certificate. The SHA1 hash is commonly specified when multiple certificates satisfy the criteria specified by the remaining switches. Works only on Windows (or on macOS if [Parallels Desktop](https://www.parallels.com/products/desktop/) Windows 10 virtual machines exits).
* @deprecated Please use win.signtoolOptions.certificateSha1
* @deprecated Please use {@link signtoolOptions}: {@link WindowsSigntoolConfiguration.certificateSha1}
*/
readonly certificateSha1?: string | null
/**
* The path to an additional certificate file you want to add to the signature block.
* @deprecated Please use {@link signtoolOptions.additionalCertificateFile}
* @deprecated Please use {@link signtoolOptions}: {@link WindowsSigntoolConfiguration.additionalCertificateFile}
*/
readonly additionalCertificateFile?: string | null
/**
* The URL of the RFC 3161 time stamp server.
* @default http://timestamp.digicert.com
* @deprecated Please use {@link signtoolOptions.rfc3161TimeStampServer}
* @deprecated Please use {@link signtoolOptions}: {@link WindowsSigntoolConfiguration.rfc3161TimeStampServer}
*/
readonly rfc3161TimeStampServer?: string | null
/**
* The URL of the time stamp server.
* @default http://timestamp.digicert.com
* @deprecated Please use {@link signtoolOptions.timeStampServer}
* @deprecated Please use {@link signtoolOptions}: {@link WindowsSigntoolConfiguration.timeStampServer}
*/
readonly timeStampServer?: string | null

/**
* [The publisher name](https://github.com/electron-userland/electron-builder/issues/1187#issuecomment-278972073), exactly as in your code signed certificate. Several names can be provided.
* Defaults to common name from your code signing certificate.
* @deprecated Please use {@link signtoolOptions.publisherName}
* @deprecated Please use {@link signtoolOptions}: {@link WindowsSigntoolConfiguration.publisherName}
*/
readonly publisherName?: string | Array<string> | null

Expand Down
2 changes: 1 addition & 1 deletion pages/code-signing.md
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ To sign using Azure Tenant account, you'll need the following env variables set
| `AZURE_USERNAME` |
| `AZURE_PASSWORD` |

`win.azureOptions` needs to be configured per [Microsoft's instructions](https://learn.microsoft.com/en-us/azure/trusted-signing/how-to-signing-integrations#create-a-json-file) directly in electron-builder's configuration. Additional fields can be provided that are passed directly to `Invoke-TrustedSigning` powershell command.
`win.azureSignOptions` needs to be configured per [Microsoft's instructions](https://learn.microsoft.com/en-us/azure/trusted-signing/how-to-signing-integrations#create-a-json-file) directly in electron-builder's configuration. Additional fields can be provided that are passed directly to `Invoke-TrustedSigning` powershell command.

## Alternative methods of codesigning

Expand Down
Loading