Skip to content

Commit 21623e1

Browse files
authored
chore: cleaning up readme and removing super old boilerplate links (#9334)
1 parent 86e5586 commit 21623e1

File tree

6 files changed

+18
-15
lines changed

6 files changed

+18
-15
lines changed

.changeset/long-planes-lay.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
"electron-updater": patch
3+
"app-builder-lib": patch
4+
---
5+
6+
chore: remove "beta" labels from a few features

README.md

Lines changed: 8 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -96,17 +96,18 @@ See the full documentation on [electron.build](https://www.electron.build).
9696
| “I want to support development” | [Donate](https://www.electron.build/donate) |
9797

9898
## Installation
99-
[Yarn](http://yarnpkg.com/) is [strongly](https://github.com/electron-userland/electron-builder/issues/1147#issuecomment-276284477) recommended instead of npm.
100-
101-
`yarn add electron-builder --dev`
99+
```
100+
yarn add electron-builder --dev
101+
// or npm, pnpm, bun
102+
```
102103

103104
### Note for Yarn 3
104105

105-
Yarn 3 use PnP by default, but electron-builder still need node-modules(ref: [yarnpkg/berry#4804](https://github.com/yarnpkg/berry/issues/4804#issuecomment-1234407305)). Add configuration in the `.yarnrc.yaml` as follows:
106+
Yarn 3 use PnP by default, but electron-builder still needs node-modules (ref: [yarnpkg/berry#4804](https://github.com/yarnpkg/berry/issues/4804#issuecomment-1234407305)). Add configuration in the `.yarnrc.yaml` as follows:
106107
```
107108
nodeLinker: "node-modules"
108109
```
109-
will declare to use node-modules instead of PnP.
110+
This will declare to use node-modules instead of PnP.
110111

111112
## Quick Setup Guide
112113

@@ -170,13 +171,9 @@ builder.build({
170171
})
171172
```
172173

173-
## Boilerplates
174+
## Community Boilerplates
174175

175-
* [electron-webpack-quick-start](https://github.com/electron-userland/electron-webpack-quick-start) — A bare minimum project structure to get started developing with [electron-webpack](https://github.com/electron-userland/electron-webpack). Recommended.
176176
* [electron-react-boilerplate](https://github.com/chentsulin/electron-react-boilerplate) A boilerplate for scalable cross-platform desktop apps.
177-
* [electron-react-redux-boilerplate](https://github.com/jschr/electron-react-redux-boilerplate) A minimal boilerplate to get started with Electron, React and Redux.
178-
* [electron-boilerplate](https://github.com/szwacz/electron-boilerplate) A minimalistic yet comprehensive boilerplate application.
179-
* [Vue CLI 3 plugin for Electron](https://nklayman.github.io/vue-cli-plugin-electron-builder) A Vue CLI 3 plugin for Electron with no required configuration.
180177
* [electron-vue-vite](https://github.com/caoxiemeihao/electron-vue-vite) A real simple Electron + Vue3 + Vite5 boilerplate.
181178
* [vite-electron-builder](https://github.com/cawa-93/vite-electron-builder) Secure boilerplate for Electron app based on Vite. Supports multiple frameworks.
182179
* [electronjs-with-nextjs](https://github.com/saulotarsobc/electronjs-with-nextjs) ElectronJS application with NextJS and TypeScript.
@@ -201,7 +198,7 @@ DEBUG=electron-builder
201198
!!! tip "PowerShell"
202199
PowerShell uses different syntax to set environment variables.
203200
```bash
204-
$env:DEBUG=electron-builder
201+
$env:DEBUG = "electron-builder"
205202
```
206203

207204
## Donate

packages/app-builder-lib/scheme.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6536,7 +6536,7 @@
65366536
"type": "null"
65376537
}
65386538
],
6539-
"description": "Options for usage of Azure Trusted Signing (beta)\nCannot be used in conjunction with `signtoolOptions`, signing will default to Azure Trusted Signing"
6539+
"description": "Options for usage of Azure Trusted Signing service\nCannot be used in conjunction with `signtoolOptions`, signing will default to Azure Trusted Signing"
65406540
},
65416541
"compression": {
65426542
"anyOf": [

packages/app-builder-lib/src/codeSign/windowsCodeSign.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ export async function signWindows(options: WindowsSignOptions, packager: WinPack
1212
if (options.options.signtoolOptions) {
1313
log.warn(null, "ignoring signtool options, using Azure Trusted Signing; please only configure one")
1414
}
15-
log.info({ path: log.filePath(options.path) }, "signing with Azure Trusted Signing (beta)")
15+
log.info({ path: log.filePath(options.path) }, "signing with Azure Trusted Signing")
1616
} else {
1717
log.info({ path: log.filePath(options.path) }, "signing with signtool.exe")
1818
}

packages/app-builder-lib/src/options/winOptions.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ export interface WindowsConfiguration extends PlatformSpecificBuildOptions {
3131
readonly signtoolOptions?: WindowsSigntoolConfiguration | null
3232

3333
/**
34-
* Options for usage of Azure Trusted Signing (beta)
34+
* Options for usage of Azure Trusted Signing service
3535
* Cannot be used in conjunction with `signtoolOptions`, signing will default to Azure Trusted Signing
3636
*/
3737
readonly azureSignOptions?: WindowsAzureSigningConfiguration | null

packages/electron-updater/src/main.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ function doLoadAutoUpdater(): AppUpdater {
5252
}
5353
} catch (error: any) {
5454
console.warn(
55-
"Unable to detect 'package-type' for autoUpdater (beta rpm/deb/pacman support). If you'd like to expand support, please consider contributing to electron-builder",
55+
"Unable to detect 'package-type' for autoUpdater (rpm/deb/pacman support). If you'd like to expand support, please consider contributing to electron-builder",
5656
error.message
5757
)
5858
}

0 commit comments

Comments
 (0)