Skip to content

Commit b08ef62

Browse files
committed
Merge branch 'release/4.1.3' into develop
2 parents 8c29fc7 + 3fba67c commit b08ef62

7 files changed

+137
-301
lines changed

.github/workflows/close-stale.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ name: Close stale issues and PRs
22

33
on:
44
schedule:
5-
- cron: '*/10 * * * *'
5+
- cron: '0 23 * * *'
66

77
permissions:
88
issues: write

.github/workflows/nodejs.yml

+1
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ on:
66
branches:
77
- master
88
- develop
9+
- 'release/**'
910
pull_request:
1011
branches:
1112
- '**'

CHANGELOG_PRE_V4.md

+29-69
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,14 @@
11
# Changelog (pre `v4`)
22
All notable changes up to `v3.0.0` are documented in this file.
33

4-
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
5-
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
6-
7-
## [Unreleased]
4+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
85

96
## [3.0.0] - 2020-12-26
107
### Added
118
- NPM packages `react-router` & `react-router-dom` to package dependencies.
12-
- NPM package `eslint-plugin-react-hooks` to `devDependencies` as required by
13-
the updated version of `eslint-config-airbnb`.
14-
- NPM package `copy-webpack-plugin` to `devDependencies` as replacement of
15-
`copy-pkg-json-webpack-plugin`.
16-
- NPM packages `@typescript-eslint/eslint-plugin` & `@typescript-eslint/parser`
17-
to `devDependencies` for using ESLint to lint TypeScript.
9+
- NPM package `eslint-plugin-react-hooks` to `devDependencies` as required by the updated version of `eslint-config-airbnb`.
10+
- NPM package `copy-webpack-plugin` to `devDependencies` as replacement of `copy-pkg-json-webpack-plugin`.
11+
- NPM packages `@typescript-eslint/eslint-plugin` & `@typescript-eslint/parser` to `devDependencies` for using ESLint to lint TypeScript.
1812

1913
### Changed
2014
- __Project is now being developed based on Node.js `v14 (LTS)`.__
@@ -44,12 +38,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
4438
- `typescript` - `3.7.2` - > `4.1.3`
4539
- `webpack` - `4.41.2` -> `5.11.0`
4640
- `webpack-cli` - `3.3.10` -> `4.3.0`
47-
- Moved `@types` packages from `dependencies` to `devDependencies` as those
48-
have no need to be included in production builds.
41+
- Moved `@types` packages from `dependencies` to `devDependencies` as those have no need to be included in production builds.
4942
- Commands of NPM scripts `dev` & `prod` to make them work with Webpack 5.
5043
- Migrated to ESLint from TSLint.
51-
- Updated prefix of internal paths from `@` to `_` to avoid confusions with
52-
scoped NPM packages.
44+
- Updated prefix of internal paths from `@` to `_` to avoid confusions with scoped NPM packages.
5345
- Indentation for `.ts` files is now set as `2` spaces instead of `4`.
5446
- `electron-builder` settings:
5547
- `win`:
@@ -58,47 +50,35 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
5850
- Allowed custom installation directory in the installer built.
5951
- `mac`:
6052
- Changed build target back to `dmg`.
61-
- `buildVersion` is now being used as build number instead of just another
62-
parameter for semantic version number.
53+
- `buildVersion` is now being used as build number instead of just another parameter for semantic version number.
6354
- Updated section `Known issues` in `README`.
6455

6556
### Fixed
6657
- ESLint errors/warnings on `main.ts` & `renderer.tsx`.
67-
- `electron-builder` fails to build `dmg` on `macOS` (issue
68-
[electron-builder #3990])by upgrading the package version to `> 21.2.0`.
58+
- `electron-builder` fails to build `dmg` on `macOS` (issue [electron-builder #3990])by upgrading the package version to `> 21.2.0`.
6959

7060
### Removed
71-
- NPM package `copy-pkg-json-webpack-plugin` as it doesn't work with Webpack 5
72-
and seems not very well maintained.
73-
- NPM packages `acorn` & `ajv` from `devDependencies` as they're not being used
74-
in this boilerplate.
75-
- NPM packages `tslint` & `tslint-microsoft-contrib` as TSLint is now
76-
deprecated.
61+
- NPM package `copy-pkg-json-webpack-plugin` as it doesn't work with Webpack 5 and seems not very well maintained.
62+
- NPM packages `acorn` & `ajv` from `devDependencies` as they're not being used in this boilerplate.
63+
- NPM packages `tslint` & `tslint-microsoft-contrib` as TSLint is now deprecated.
7764

7865
## [2.0.2] - 2019-12-02
79-
`v2.0.2` is a minor hotfix release fixed the documentation error and build
80-
error on `macOS Catalina(10.15+)`.
66+
`v2.0.2` is a minor hotfix release fixed the documentation error and build error on `macOS Catalina(10.15+)`.
8167

8268
### Added
83-
- Extended README section `Getting started` with `npm start` command
84-
description.
69+
- Extended README section `Getting started` with `npm start` command description.
8570
- README section `Known issue`.
8671

8772
### Changed
8873
- Minor version upgrades on package dependencies.
89-
- `macOS` build target to `pkg` from default `dmg` due to no 32-bit apps
90-
support from `macOS Catalina` that caused `electron-builder` fails to build
91-
`dmg` image on `macOS` prior to `electron-builder@21.2.0`.
92-
_`pkg` build is unaffected and is used as a workaround for the current version
93-
prior to the major version upgrades on dependencies in next release._
94-
_Related issue: [electron-builder #3990](https://github.com/electron-userland/electron-builder/issues/3990)_
74+
- `macOS` build target to `pkg` from default `dmg` due to no 32-bit apps support from `macOS Catalina` that caused `electron-builder` fails to build `dmg` image on `macOS` prior to `electron-builder@21.2.0`.
75+
- _`pkg` build is unaffected and is used as a workaround for the current version prior to the major version upgrades on dependencies in next release. Related issue: [electron-builder #3990](https://github.com/electron-userland/electron-builder/issues/3990)_
9576

9677
### Fixed
9778
- [Issue #2] - incorrect command `npm run install` to `npm install` in `README`.
9879

9980
## [2.0.1] - 2018-02-05
100-
`v2.0.1` is a minor hotfix release patched the `NODE_ENV` not set on Windows
101-
issue.
81+
`v2.0.1` is a minor hotfix release patched the `NODE_ENV` not set on Windows issue.
10282

10383
### Added
10484
- Package `cross-env` as `devDependencies`.
@@ -114,46 +94,26 @@ issue.
11494
- ESLint for code checking on Javascript files.
11595
- Airbnb's extensible `.eslintrc` package & its' peer dependencies.
11696
- `.eslintrc` that extends Airbnb's config and has customised rules configured.
117-
- _Rule `no-default-export` is set for JavaScript files to align with
118-
TypeScript._
119-
- ESLint plugin `eslint-import-resolver-webpack` for ESLint to resolve path
120-
aliases set in Webpack config.
121-
- Webpack plugin `copy-pkg-json-webpack-plugin` to generate a `package.json`
122-
file and pack into Webpack's bundled package for production.
123-
- Build commands `build:mac` & `build:win` to package & build the installer of
124-
your Electron app for macOS & Windows using `electron-builder`.
125-
- README section "Building the installer for your Electron app" & sub-section
126-
"Extra options".
97+
- _Rule `no-default-export` is set for JavaScript files to align with TypeScript._
98+
- ESLint plugin `eslint-import-resolver-webpack` for ESLint to resolve path aliases set in Webpack config.
99+
- Webpack plugin `copy-pkg-json-webpack-plugin` to generate a `package.json` file and pack into Webpack's bundled package for production.
100+
- Build commands `build:mac` & `build:win` to package & build the installer of your Electron app for macOS & Windows using `electron-builder`.
101+
- README section "Building the installer for your Electron app" & sub-section "Extra options".
127102

128103
### Changed
129-
- Refactored Webpack config file to have `mainConfig` & `rendererConfig`
130-
cleaned up, and set mode by environment variable.
131-
- `.gitignore` to ignore folder `out/` which will be auto-generated during the
132-
build process.
133-
- README section "How does it work?" is now renamed to "Getting started" &
134-
completed the documentation of this section.
104+
- Refactored Webpack config file to have `mainConfig` & `rendererConfig` cleaned up, and set mode by environment variable.
105+
- `.gitignore` to ignore folder `out/` which will be auto-generated during the build process.
106+
- README section "How does it work?" is now renamed to "Getting started" & completed the documentation of this section.
135107
- README section "Folder structure" to reflect the changes in `v2.0.0`.
136108

137109
### Fixed
138-
- CSS files fail to inject into views issue by setting Webpack to use
139-
`style-loader` alongside with `css-loader` to bundle the files in Webpack
140-
config file.
141-
- `baseUrl` in `tsconfig.json` points to root directory incorrectly issue.
142-
Corrected to current directory so VSCode can resolves the path aliases
143-
correctly.
110+
- CSS files fail to inject into views issue by setting Webpack to use `style-loader` alongside with `css-loader` to bundle the files in Webpack config file.
111+
- `baseUrl` in `tsconfig.json` points to root directory incorrectly issue. Corrected to current directory so VSCode can resolves the path aliases correctly.
144112

145113
### Removed
146-
- Redux & React-Redux related settings, including packages listed on
147-
`devDependencies`, path aliases & folders listed in folder structure.
148-
- Since Electron's built-in IPC & basic React states should be enough to get
149-
the works done, and most Electron apps which have their application logic
150-
runs on Electron's `main` process rather then `renderer` process actually
151-
don't need React-Redux, `redux` & `react-redux` are no longer included in
152-
this boilerplate.
153-
- Redux & React-Redux can still be used on this boilerplate by installing the
154-
package yourself. For details, please refer to the corresponding library's
155-
documents, there's no different than working on any other project which
156-
isn't based on this boilerplate.
114+
- Redux & React-Redux related settings, including packages listed on `devDependencies`, path aliases & folders listed in folder structure.
115+
- Since Electron's built-in IPC & basic React states should be enough to get the works done, and most Electron apps which have their application logic runs on Electron's `main` process rather then `renderer` process actually don't need React-Redux, `redux` & `react-redux` are no longer included in this boilerplate.
116+
- Redux & React-Redux can still be used on this boilerplate by installing the package yourself. For details, please refer to the corresponding library's documents, there's no different than working on any other project which isn't based on this boilerplate.
157117
- Separated Webpack config files for `development` & `production` mode.
158118

159119
[Unreleased]: https://github.com/Devtography/electron-react-typescript-webpack-boilerplate/compare/v3.0.0...HEAD

0 commit comments

Comments
 (0)