@release-it/keep-a-changelog 4.0.0 → 5.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,30 @@
1
+ name: Cross-OS Tests
2
+
3
+ on: [push, pull_request]
4
+
5
+ jobs:
6
+ test:
7
+ strategy:
8
+ matrix:
9
+ os:
10
+ - ubuntu-latest
11
+ - windows-latest
12
+ - macos-latest
13
+ node:
14
+ - 18
15
+ - 20
16
+
17
+ runs-on: ${{ matrix.os }}
18
+ name: ${{ matrix.os }} (Node v${{ matrix.node }})
19
+
20
+ steps:
21
+ - uses: actions/checkout@v3
22
+ - uses: actions/setup-node@v3
23
+ with:
24
+ node-version: ${{ matrix.node }}
25
+
26
+ - name: Install dependencies
27
+ run: npm install
28
+
29
+ - name: Run tests
30
+ run: npm test
package/README.md CHANGED
@@ -3,6 +3,13 @@
3
3
  This [release-it plugin](https://github.com/release-it/release-it/blob/master/docs/plugins.md) maintains your
4
4
  CHANGELOG.md file according to the [Keep A Changelog](https://keepachangelog.com/) standards.
5
5
 
6
+ It updates the changelog automatically by:
7
+
8
+ - replacing the `## [Unreleased]` header with the current version and release date.
9
+ - [optionally] adding a new `## [Unreleased]` header as preparation for future changes.
10
+
11
+ It does not automatically populate the changelog with commit messages from the git history!
12
+
6
13
  The idea and initial implementation comes [from @eMarek](https://github.com/release-it/release-it/issues/662).
7
14
 
8
15
  ```
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@release-it/keep-a-changelog",
3
- "version": "4.0.0",
3
+ "version": "5.0.0",
4
4
  "description": "Keep-a-changelog plugin for release-it",
5
5
  "type": "module",
6
6
  "exports": "./index.js",
@@ -30,20 +30,20 @@
30
30
  "url": "https://webpro.nl"
31
31
  },
32
32
  "dependencies": {
33
- "detect-newline": "^4.0.0",
33
+ "detect-newline": "^4.0.1",
34
34
  "string-template": "^1.0.0"
35
35
  },
36
36
  "devDependencies": {
37
37
  "bron": "^2.0.3",
38
38
  "mock-fs": "^5.1.4",
39
- "release-it": "^16.0.0",
40
- "sinon": "^15.2.0"
39
+ "release-it": "^17.0.0",
40
+ "sinon": "^17.0.1"
41
41
  },
42
42
  "peerDependencies": {
43
- "release-it": "^16.0.0"
43
+ "release-it": "^17.0.0"
44
44
  },
45
45
  "engines": {
46
- "node": ">=16"
46
+ "node": ">=18"
47
47
  },
48
48
  "release-it": {
49
49
  "github": {