Skip to content

Commit 43b59f4

Browse files
committed
Update docs
- Updated CHANGELOG & README for changes made.
1 parent 6a9b7ae commit 43b59f4

File tree

2 files changed

+14
-5
lines changed

2 files changed

+14
-5
lines changed

CHANGELOG_V4+.md

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,20 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
55
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
66

77
## [Unreleased]
8+
### Added
9+
- GitHub workflows for CI.
10+
- Jest config for GitHub Actions - `jest.config.ci.mjs`.
11+
- NPM scripts:
12+
- `lint` to run ESLint from CLI.
13+
- `jest` to replace the original `test` script with the following changes:
14+
- Removed `jest --clearCache` at the beginning as the updated Jest & ts-jest
15+
settings execute the dynamic import lines with no issue.
16+
- Disabled Node experimental warning message by setting `NODE_NO_WARNINGS=1`.
17+
- `jest-ci` to run Jest with CI config - `jest.config.ci.mjs`.
18+
819
### Changed
920
- File extension of Jest & Webpack config files to `mjs`.
10-
- NPM `test` script:
11-
- Removed `jest --clearCache` at the beginning as the updated Jest & ts-jest
12-
settings execute the dynamic import lines with no issue.
13-
- Disabled Node experimental warning message by setting `NODE_NO_WARNINGS=1`.
21+
- NPM `test` script to run scripts `lint` then `jest`.
1422
- Rolled back the value of `moduleResolution` in `tsconfig` to `Node` (means
1523
`.js` file extension on relative imports is now __OPTIONAL__).
1624
- Enhanced function `pathsToESModuleNameMapper` in `jest.config.js` to return a

README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -275,7 +275,8 @@ To package your Electron app, run `npm run prod` to get your code compiled in
275275
- `.gitignore` - Git ignore file
276276
- `CHANGELOG_PRE_V4.md` - Changelog of this boilerplate prior to `v4.0.0`
277277
- `CHANGELOG_V4+.md` - Changelog of this boilerplate from `v4.0.0` onwards
278-
- `jest.config.js` - [Jest] config file
278+
- `jest.config.ci.mjs` - [Jest] config file for GitHub Actions
279+
- `jest.config.mjs` - [Jest] config file
279280
- `LICENSE` - MIT license
280281
- `package-lock.json`
281282
- `package.json`

0 commit comments

Comments
 (0)