|
| 1 | +# Changelog |
| 2 | +All notable changes to this project will be documented in this file. |
| 3 | +This project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html). |
| 4 | + |
| 5 | +{{ if .Versions -}} |
| 6 | +A list of unreleased changes can be found [here]({{ .Info.RepositoryURL }}/compare/{{ $latest := index .Versions 0 }}{{ $latest.Tag.Name }}...HEAD). |
| 7 | +{{ end -}} |
| 8 | + |
| 9 | +{{ range .Versions }} |
| 10 | +<a name="{{ .Tag.Name }}"></a> |
| 11 | +## {{ if .Tag.Previous }}[{{ .Tag.Name }}]{{ else }}{{ .Tag.Name }}{{ end }} - {{ datetime "2006-01-02" .Tag.Date }} |
| 12 | +{{ range .CommitGroups -}} |
| 13 | +### {{ .Title }} |
| 14 | +{{ range .Commits -}} |
| 15 | +- {{ if .Scope }}**{{ .Scope }}:** {{ end }}{{ .Subject }} [`{{ .Hash.Short }}`]({{ $.Info.RepositoryURL }}/commit/{{ .Hash.Long }}) |
| 16 | +{{ end }} |
| 17 | +{{ end -}} |
| 18 | + |
| 19 | +{{- if .RevertCommits -}} |
| 20 | +### Reverts |
| 21 | +{{ range .RevertCommits -}} |
| 22 | +- {{ .Revert.Header }} |
| 23 | +{{ end }} |
| 24 | +{{ end -}} |
| 25 | + |
| 26 | +{{- if .NoteGroups -}} |
| 27 | +{{ range .NoteGroups -}} |
| 28 | +### {{ .Title }} |
| 29 | +{{ range .Notes }} |
| 30 | +{{ .Body }} |
| 31 | +{{ end }} |
| 32 | +{{ end -}} |
| 33 | +{{ end -}} |
| 34 | +{{ end -}} |
| 35 | + |
| 36 | +<a name="v3.0.0"></a> |
| 37 | +## [v3.0.0] - 2023-02-09 |
| 38 | +### Breaking Changes |
| 39 | + |
| 40 | +- Replace npmlog with @ui5/logger/Logger (#363) [`66a159a`](https://github.com/SAP/ui5-logger/commit/66a159acd9b67a27dd66d1e8056c362585f51bcf) |
| 41 | +- Deprecate advanced APIs in preparation of refactoring [`3aea5e7`](https://github.com/SAP/ui5-logger/commit/3aea5e766f9bda156e8c7e62a2e8c65f613ef7e9) |
| 42 | +- Transform to ES Modules ([#306](https://github.com/SAP/ui5-logger/issues/306)) [`c79608b`](https://github.com/SAP/ui5-logger/commit/c79608b0e432168ca8570530b63a456b9ddd12cb) |
| 43 | +- Require Node.js ^16.18.0, >=18.12.0 / npm >= 8 [`a8af8a7`](https://github.com/SAP/ui5-logger/commit/a8af8a7a82c6f657ac10b5018e654939d90fd81f) |
| 44 | + |
| 45 | +### BREAKING CHANGE |
| 46 | + |
| 47 | +The @ui5/logger got refactored and as a result its API went public. |
| 48 | + |
| 49 | +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. |
| 50 | + |
| 51 | +This breaking change removes capabilities that are likely to change and should not be part of a public API. |
| 52 | + |
| 53 | +This will ensure that later changes to the module can be donen in a |
| 54 | +compatible manner. |
| 55 | + |
| 56 | +Relevant changes: |
| 57 | + |
| 58 | +- Restrict log-methods to two argument only. The use of placeholders |
| 59 | + like '%s' is no longer supported. A warning will be logged if more |
| 60 | + than two argument is supplied. Placeholders will be replaced with a |
| 61 | + deprecation message. We suggest the use of template literals. |
| 62 | +- Deprecate #getGroupLogger method. Calling it throws an error. |
| 63 | + It will be removed in one of the next patch releases |
| 64 | +- Deprecate #setShowProgress method. Calling it throws an error. |
| 65 | + It will be removed in one of the next patch releases |
| 66 | +- Remove GroupLogger and TaskLogger classes. Similar functionality might |
| 67 | + be re-added in a later release. |
| 68 | + |
| 69 | +This package has been transformed to ES Modules. Therefore it no longer provides a CommonJS export. |
| 70 | +If your project uses CommonJS, it needs to be converted to ES Modules or use a dynamic import. |
| 71 | + |
| 72 | +For more information see also: |
| 73 | + |
| 74 | +- https://sap.github.io/ui5-tooling/updates/migrate-v3/ |
| 75 | +- https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c |
| 76 | + |
| 77 | +Support for older Node.js and npm releases has been dropped. |
| 78 | +Only Node.js versions v16.18.0, v18.12.0 or higher as well as npm v8 or higher are supported. |
| 79 | + |
| 80 | +### Features |
| 81 | + |
| 82 | +- Add new log level "perf" [`acf0c71`](https://github.com/SAP/ui5-logger/commit/acf0c717612f440ea7a114e757c05d358ae523a7) |
| 83 | + |
| 84 | + |
| 85 | +<a name="v2.0.1"></a> |
| 86 | +## [v2.0.1] - 2020-10-22 |
| 87 | +### Bug Fixes |
| 88 | +- Typos in error messages [`1d25902`](https://github.com/SAP/ui5-logger/commit/1d2590223c4332f5ea6f1326b23ecf584fea5934) |
| 89 | + |
| 90 | +<a name="v2.0.0"></a> |
| 91 | +## [v2.0.0] - 2020-03-31 |
| 92 | +### Breaking Changes |
| 93 | +- Require Node.js >= 10 [`1825d10`](https://github.com/SAP/ui5-logger/commit/1825d1013a88f164cbbfbf579c3e8e02df2b5082) |
| 94 | + |
| 95 | +### BREAKING CHANGE |
| 96 | + |
| 97 | +Support for older Node.js releases has been dropped. |
| 98 | +Only Node.js v10 or higher is supported. |
| 99 | + |
| 100 | +<a name="v1.0.2"></a> |
| 101 | +## [v1.0.2] - 2019-10-14 |
| 102 | +### Bug Fixes |
| 103 | +- Fix handling of log level "silent" [`020ced8`](https://github.com/SAP/ui5-logger/commit/020ced85a82d33c94e429aa28983affa0d8341ba) |
| 104 | + |
| 105 | +<a name="v1.0.1"></a> |
| 106 | +## [v1.0.1] - 2019-03-21 |
| 107 | + |
| 108 | +<a name="v1.0.0"></a> |
| 109 | +## [v1.0.0] - 2019-01-09 |
| 110 | + |
| 111 | +<a name="v0.2.2"></a> |
| 112 | +## [v0.2.2] - 2018-11-16 |
| 113 | +### Features |
| 114 | +- Add UI5_LOG_LVL environment variable [`c3e65c4`](https://github.com/SAP/ui5-logger/commit/c3e65c444045832773e4dc43ffa2baf903a27e52) |
| 115 | + |
| 116 | +<a name="v0.2.1"></a> |
| 117 | +## [v0.2.1] - 2018-10-29 |
| 118 | + |
| 119 | +<a name="v0.2.0"></a> |
| 120 | +## [v0.2.0] - 2018-07-11 |
| 121 | + |
| 122 | +<a name="v0.1.0"></a> |
| 123 | +## [v0.1.0] - 2018-06-26 |
| 124 | + |
| 125 | +<a name="v0.0.1"></a> |
| 126 | +## v0.0.1 - 2018-06-06 |
| 127 | + |
| 128 | +{{- if .Versions }} |
| 129 | +{{ range .Versions -}} |
| 130 | +{{ if and .Tag.Previous (ne .Tag.Name "v3.0.0") -}} |
| 131 | +[{{ .Tag.Name }}]: {{ $.Info.RepositoryURL }}/compare/{{ .Tag.Previous.Name }}...{{ .Tag.Name }} |
| 132 | +{{ end -}} |
| 133 | +{{ end -}} |
| 134 | +{{ end -}} |
| 135 | +[v3.0.0]: https://github.com/SAP/ui5-logger/compare/v2.0.1...v3.0.0 |
| 136 | +[v2.0.1]: https://github.com/SAP/ui5-logger/compare/v2.0.0...v2.0.1 |
| 137 | +[v2.0.0]: https://github.com/SAP/ui5-logger/compare/v1.0.2...v2.0.0 |
| 138 | +[v1.0.2]: https://github.com/SAP/ui5-logger/compare/v1.0.1...v1.0.2 |
| 139 | +[v1.0.1]: https://github.com/SAP/ui5-logger/compare/v1.0.0...v1.0.1 |
| 140 | +[v1.0.0]: https://github.com/SAP/ui5-logger/compare/v0.2.2...v1.0.0 |
| 141 | +[v0.2.2]: https://github.com/SAP/ui5-logger/compare/v0.2.1...v0.2.2 |
| 142 | +[v0.2.1]: https://github.com/SAP/ui5-logger/compare/v0.2.0...v0.2.1 |
| 143 | +[v0.2.0]: https://github.com/SAP/ui5-logger/compare/v0.1.0...v0.2.0 |
| 144 | +[v0.1.0]: https://github.com/SAP/ui5-logger/compare/v0.0.1...v0.1.0 |
0 commit comments