Skip to content

Commit 0c37902

Browse files
authored
[INTERNAL] CHANGELOG.md: Consolidate V3 release (#376)
1 parent bb4b949 commit 0c37902

File tree

2 files changed

+103
-2
lines changed

2 files changed

+103
-2
lines changed

.chglog/CHANGELOG.tpl.md

Lines changed: 102 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,10 +33,111 @@ A list of unreleased changes can be found [here]({{ .Info.RepositoryURL }}/compa
3333
{{ end -}}
3434
{{ end -}}
3535

36+
37+
### Breaking Changes
38+
39+
- Replace npmlog with @ui5/logger/Logger (#363) [`66a159a`](https://github.com/SAP/ui5-logger/commit/66a159acd9b67a27dd66d1e8056c362585f51bcf)
40+
- Deprecate advanced APIs in preparation of refactoring [`3aea5e7`](https://github.com/SAP/ui5-logger/commit/3aea5e766f9bda156e8c7e62a2e8c65f613ef7e9)
41+
- Transform to ES Modules ([#306](https://github.com/SAP/ui5-logger/issues/306)) [`c79608b`](https://github.com/SAP/ui5-logger/commit/c79608b0e432168ca8570530b63a456b9ddd12cb)
42+
- Require Node.js ^16.18.0, >=18.12.0 / npm >= 8 [`a8af8a7`](https://github.com/SAP/ui5-logger/commit/a8af8a7a82c6f657ac10b5018e654939d90fd81f)
43+
44+
### BREAKING CHANGE
45+
46+
The @ui5/logger got refactored and as a result its API went public.
47+
48+
Remove the usage of npmlog and refactor @ui5/logger modules to emit log events which are then caught in dedicated handlers. This is somewhat inspired by npm's proc-log module.
49+
50+
This breaking change removes capabilities that are likely to change and should not be part of a public API.
51+
52+
This will ensure that later changes to the module can be donen in a
53+
compatible manner.
54+
55+
Relevant changes:
56+
57+
- Restrict log-methods to two argument only. The use of placeholders
58+
like '%s' is no longer supported. A warning will be logged if more
59+
than two argument is supplied. Placeholders will be replaced with a
60+
deprecation message. We suggest the use of template literals.
61+
- Deprecate #getGroupLogger method. Calling it throws an error.
62+
It will be removed in one of the next patch releases
63+
- Deprecate #setShowProgress method. Calling it throws an error.
64+
It will be removed in one of the next patch releases
65+
- Remove GroupLogger and TaskLogger classes. Similar functionality might
66+
be re-added in a later release.
67+
68+
This package has been transformed to ES Modules. Therefore it no longer provides a CommonJS export.
69+
If your project uses CommonJS, it needs to be converted to ES Modules or use a dynamic import.
70+
71+
For more information see also:
72+
73+
- https://sap.github.io/ui5-tooling/updates/migrate-v3/
74+
- https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c
75+
76+
Support for older Node.js and npm releases has been dropped.
77+
Only Node.js versions v16.18.0, v18.12.0 or higher as well as npm v8 or higher are supported.
78+
79+
### Features
80+
81+
- Add new log level "perf" [`acf0c71`](https://github.com/SAP/ui5-logger/commit/acf0c717612f440ea7a114e757c05d358ae523a7)
82+
83+
84+
<a name="v2.0.1"></a>
85+
## [v2.0.1] - 2020-10-22
86+
### Bug Fixes
87+
- Typos in error messages [`1d25902`](https://github.com/SAP/ui5-logger/commit/1d2590223c4332f5ea6f1326b23ecf584fea5934)
88+
89+
<a name="v2.0.0"></a>
90+
## [v2.0.0] - 2020-03-31
91+
### Breaking Changes
92+
- Require Node.js >= 10 [`1825d10`](https://github.com/SAP/ui5-logger/commit/1825d1013a88f164cbbfbf579c3e8e02df2b5082)
93+
94+
### BREAKING CHANGE
95+
96+
Support for older Node.js releases has been dropped.
97+
Only Node.js v10 or higher is supported.
98+
99+
<a name="v1.0.2"></a>
100+
## [v1.0.2] - 2019-10-14
101+
### Bug Fixes
102+
- Fix handling of log level "silent" [`020ced8`](https://github.com/SAP/ui5-logger/commit/020ced85a82d33c94e429aa28983affa0d8341ba)
103+
104+
<a name="v1.0.1"></a>
105+
## [v1.0.1] - 2019-03-21
106+
107+
<a name="v1.0.0"></a>
108+
## [v1.0.0] - 2019-01-09
109+
110+
<a name="v0.2.2"></a>
111+
## [v0.2.2] - 2018-11-16
112+
### Features
113+
- Add UI5_LOG_LVL environment variable [`c3e65c4`](https://github.com/SAP/ui5-logger/commit/c3e65c444045832773e4dc43ffa2baf903a27e52)
114+
115+
<a name="v0.2.1"></a>
116+
## [v0.2.1] - 2018-10-29
117+
118+
<a name="v0.2.0"></a>
119+
## [v0.2.0] - 2018-07-11
120+
121+
<a name="v0.1.0"></a>
122+
## [v0.1.0] - 2018-06-26
123+
124+
<a name="v0.0.1"></a>
125+
## v0.0.1 - 2018-06-06
126+
36127
{{- if .Versions }}
37128
{{ range .Versions -}}
38-
{{ if .Tag.Previous -}}
129+
{{ if and .Tag.Previous (ne .Tag.Name "v3.0.0") -}}
39130
[{{ .Tag.Name }}]: {{ $.Info.RepositoryURL }}/compare/{{ .Tag.Previous.Name }}...{{ .Tag.Name }}
40131
{{ end -}}
41132
{{ end -}}
42133
{{ end -}}
134+
[v3.0.0]: https://github.com/SAP/ui5-logger/compare/v2.0.1...v3.0.0
135+
[v2.0.1]: https://github.com/SAP/ui5-logger/compare/v2.0.0...v2.0.1
136+
[v2.0.0]: https://github.com/SAP/ui5-logger/compare/v1.0.2...v2.0.0
137+
[v1.0.2]: https://github.com/SAP/ui5-logger/compare/v1.0.1...v1.0.2
138+
[v1.0.1]: https://github.com/SAP/ui5-logger/compare/v1.0.0...v1.0.1
139+
[v1.0.0]: https://github.com/SAP/ui5-logger/compare/v0.2.2...v1.0.0
140+
[v0.2.2]: https://github.com/SAP/ui5-logger/compare/v0.2.1...v0.2.2
141+
[v0.2.1]: https://github.com/SAP/ui5-logger/compare/v0.2.0...v0.2.1
142+
[v0.2.0]: https://github.com/SAP/ui5-logger/compare/v0.1.0...v0.2.0
143+
[v0.1.0]: https://github.com/SAP/ui5-logger/compare/v0.0.1...v0.1.0

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@
4343
"jsdoc-generate": "jsdoc -c ./jsdoc.json -t $(node -p 'path.dirname(require.resolve(\"docdash\"))') ./lib/ || (echo 'Error during JSDoc generation! Check log.' && exit 1)",
4444
"jsdoc-watch": "npm run jsdoc && chokidar \"./lib/**/*.js\" -c \"npm run jsdoc-generate\"",
4545
"preversion": "npm test",
46-
"version": "git-chglog --sort semver --next-tag v$npm_package_version -o CHANGELOG.md && git add CHANGELOG.md",
46+
"version": "git-chglog --sort semver --next-tag v$npm_package_version -o CHANGELOG.md v3.0.0.. && git add CHANGELOG.md",
4747
"postversion": "git push --follow-tags",
4848
"release-note": "git-chglog --sort semver -c .chglog/release-config.yml v$npm_package_version",
4949
"depcheck": "depcheck --ignores @ui5/logger,rimraf,docdash,@istanbuljs/esm-loader-hook"

0 commit comments

Comments
 (0)