-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathCHANGELOG.html
265 lines (265 loc) · 16.7 KB
/
CHANGELOG.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
<html>
<body>
<div class="pk">
<h1 class="pk-name">Progress-Keeper</h1>
<span class="pk-desc">Track, transform and present changelog entries.</span>
<div class="pk-releases">
<div class="pk-release">
<h2 class="pk-release-version">0.4.1</h2>
<p class="pk-release-date">Date: 08.05.2018</p>
<p class="pk-release-desc">To be announced.</p>
<ul class="pk-logentries">
<li class="pk-logentry pk-logentry-type-upd">
<span class="pk-logentry-type">upd</span>
<span class="pk-logentry-desc">(doc) Added log entry example using field 'scope' (JSON sample snippet in README).</span>
</li>
</ul>
</div>
<div class="pk-release">
<h2 class="pk-release-version">0.4.0</h2>
<p class="pk-release-date">Date: 08.05.2018</p>
<p class="pk-release-desc">This release has an improved README with some detailed API usage examples.</p>
<ul class="pk-logentries">
<li class="pk-logentry pk-logentry-type-upd">
<span class="pk-logentry-type">upd</span>
<span class="pk-logentry-desc">(doc) Added CLI and API usage examples and re-ordered some paragraphs in README.</span>
</li>
<li class="pk-logentry pk-logentry-type-upd">
<span class="pk-logentry-type">upd</span>
<span class="pk-logentry-desc">progress-keeper CLI now dumps usage information if parameters are missing.</span>
</li>
</ul>
</div>
<div class="pk-release">
<h2 class="pk-release-version">0.3.4</h2>
<p class="pk-release-date">Date: 08.05.2018</p>
<p class="pk-release-desc">Another service release with few updates on internal dependencies.</p>
<ul class="pk-logentries">
<li class="pk-logentry pk-logentry-type-upd">
<span class="pk-logentry-type">upd</span>
<span class="pk-logentry-desc">(ci) Changed install workflow to 'composer update' (instead of install).</span>
</li>
<li class="pk-logentry pk-logentry-type-chore">
<span class="pk-logentry-type">chore</span>
<span class="pk-logentry-desc">Adjusted composer dependencies for alternative php versions (5 or 7) again.</span>
</li>
</ul>
</div>
<div class="pk-release">
<h2 class="pk-release-version">0.3.3</h2>
<p class="pk-release-date">Date: 03.05.2018</p>
<p class="pk-release-desc">Small service release with few updates on internal dependencies.</p>
<ul class="pk-logentries">
<li class="pk-logentry pk-logentry-type-chore">
<span class="pk-logentry-type">chore</span>
<span class="pk-logentry-desc">Updated to latest composer version (included as phar file).</span>
</li>
<li class="pk-logentry pk-logentry-type-chore">
<span class="pk-logentry-type">chore</span>
<span class="pk-logentry-desc">Updated dependency on league/commonmark (0.17.0 -> 0.17.5).</span>
</li>
</ul>
</div>
<div class="pk-release">
<h2 class="pk-release-version">0.3.2</h2>
<p class="pk-release-date">Date: 26.03.2018</p>
<p class="pk-release-desc">Small bugfix release providing a fix for the HTML presenter.</p>
<ul class="pk-logentries">
<li class="pk-logentry pk-logentry-type-fix">
<span class="pk-logentry-type">fix</span>
<span class="pk-logentry-desc">HTML presenter won't convert special characters into their corresponding html entities.</span>
</li>
</ul>
</div>
<div class="pk-release">
<h2 class="pk-release-version">0.3.1</h2>
<p class="pk-release-date">Date: 26.02.2018</p>
<p class="pk-release-desc">Small service release providing some improvements in detail.</p>
<ul class="pk-logentries">
<li class="pk-logentry pk-logentry-type-doc">
<span class="pk-logentry-type">doc</span>
<span class="pk-logentry-desc">Improved introduction, corrected some details about current API, added hints for contributors.</span>
</li>
<li class="pk-logentry pk-logentry-type-upd">
<span class="pk-logentry-type">upd</span>
<span class="pk-logentry-desc">BREAKING CHANGE: HTML presenter now renders the log entry scope value (if present) as prefix of the description.</span>
</li>
<li class="pk-logentry pk-logentry-type-upd">
<span class="pk-logentry-type">upd</span>
<span class="pk-logentry-desc">HTML presenter now adds a css class 'pk-logentry-type-[type]' class to log entry inline element.</span>
</li>
<li class="pk-logentry pk-logentry-type-chore">
<span class="pk-logentry-type">chore</span>
<span class="pk-logentry-desc">(ci) Added additional Travis CI test runner for PHP 7.2.</span>
</li>
</ul>
</div>
<div class="pk-release">
<h2 class="pk-release-version">0.3.0</h2>
<p class="pk-release-date">Date: 26.02.2018</p>
<p class="pk-release-desc">Simple markdown presenter, new progress-keeper command, Travis CI integration and more.</p>
<ul class="pk-logentries">
<li class="pk-logentry pk-logentry-type-doc">
<span class="pk-logentry-type">doc</span>
<span class="pk-logentry-desc">Added Travis CI badge.</span>
</li>
<li class="pk-logentry pk-logentry-type-doc">
<span class="pk-logentry-type">doc</span>
<span class="pk-logentry-desc">Added syntax highlighting for JSON changelog example.</span>
</li>
<li class="pk-logentry pk-logentry-type-doc">
<span class="pk-logentry-type">doc</span>
<span class="pk-logentry-desc">Updated README by adding a paragraph about the internal JSON format plus some basic model and API concepts.</span>
</li>
<li class="pk-logentry pk-logentry-type-feat">
<span class="pk-logentry-type">feat</span>
<span class="pk-logentry-desc">Added new reader type: Markdown. Parses a markdown changelog from AST which is structured like the one the markdown presenter generates.</span>
</li>
<li class="pk-logentry pk-logentry-type-feat">
<span class="pk-logentry-type">feat</span>
<span class="pk-logentry-desc">Extended LogEntryType by introducing field 'scope' and adding methods parsing type, scope and description from conventional commit messages and types.</span>
</li>
<li class="pk-logentry pk-logentry-type-feat">
<span class="pk-logentry-type">feat</span>
<span class="pk-logentry-desc">Added simple command which calls factory method 'getConvertedChangelog' with CLI arguments.</span>
</li>
<li class="pk-logentry pk-logentry-type-feat">
<span class="pk-logentry-type">feat</span>
<span class="pk-logentry-desc">Added new presenter: Markdown. Allows for generating simple markdown from given changelog.</span>
</li>
<li class="pk-logentry pk-logentry-type-upd">
<span class="pk-logentry-type">upd</span>
<span class="pk-logentry-desc">BREAKING CHANGE: Markdown presenter now renders types in the form 'type:' instead of '[type]'.</span>
</li>
<li class="pk-logentry pk-logentry-type-upd">
<span class="pk-logentry-type">upd</span>
<span class="pk-logentry-desc">BREAKING CHANGE: Changed output for HTML presenter: New tag structure and prettified formatting.</span>
</li>
<li class="pk-logentry pk-logentry-type-refac">
<span class="pk-logentry-type">refac</span>
<span class="pk-logentry-desc">BREAKING CHANGE: Renamed methods for parsing changelog, releases and log entries from from array to readFromArray().</span>
</li>
<li class="pk-logentry pk-logentry-type-refac">
<span class="pk-logentry-type">refac</span>
<span class="pk-logentry-desc">BREAKING CHANGE: Changed signature of LogEntryType constructor now parsing first argument as 'conventional commit message'.</span>
</li>
<li class="pk-logentry pk-logentry-type-refac">
<span class="pk-logentry-type">refac</span>
<span class="pk-logentry-desc">Extracted AbstractReader providing basic member and access methods.</span>
</li>
<li class="pk-logentry pk-logentry-type-refac">
<span class="pk-logentry-type">refac</span>
<span class="pk-logentry-desc">Extracted method getCanonicalType() and moved it to class LogEntryType.</span>
</li>
<li class="pk-logentry pk-logentry-type-test">
<span class="pk-logentry-type">test</span>
<span class="pk-logentry-desc">Added test class for testing presenters + extracted sample changelog generation to JsonSampleTextCase super class.</span>
</li>
<li class="pk-logentry pk-logentry-type-chore">
<span class="pk-logentry-type">chore</span>
<span class="pk-logentry-desc">Locked composer deps to PHP 5.6 compatible versions.</span>
</li>
<li class="pk-logentry pk-logentry-type-chore">
<span class="pk-logentry-type">chore</span>
<span class="pk-logentry-desc">(ci) Added integration with Travis CI.</span>
</li>
<li class="pk-logentry pk-logentry-type-chore">
<span class="pk-logentry-type">chore</span>
<span class="pk-logentry-desc">Added composer 'pre-commit' script which builds markdown and HTML versions of the own PK changelog.</span>
</li>
<li class="pk-logentry pk-logentry-type-chore">
<span class="pk-logentry-type">chore</span>
<span class="pk-logentry-desc">Renamed 'release-info.json' files to 'pk-changelog.json'.</span>
</li>
</ul>
</div>
<div class="pk-release">
<h2 class="pk-release-version">0.2.0</h2>
<p class="pk-release-date">Date: 14.02.2018</p>
<p class="pk-release-desc">New log entry type list + filter and sort methods + a lot of housekeeping.</p>
<ul class="pk-logentries">
<li class="pk-logentry pk-logentry-type-feat">
<span class="pk-logentry-type">feat</span>
<span class="pk-logentry-desc">Added method to fetch latest release (i.e. top most) of a changelog.</span>
</li>
<li class="pk-logentry pk-logentry-type-feat">
<span class="pk-logentry-type">feat</span>
<span class="pk-logentry-desc">Added method to fetch version string of latest release (i.e. top most) of a changelog.</span>
</li>
<li class="pk-logentry pk-logentry-type-feat">
<span class="pk-logentry-type">feat</span>
<span class="pk-logentry-desc">Added methods to order (group) log entries by type, using default or a custom type order.</span>
</li>
<li class="pk-logentry pk-logentry-type-feat">
<span class="pk-logentry-type">feat</span>
<span class="pk-logentry-desc">Added methods to filter log entries to specific audience(s).</span>
</li>
<li class="pk-logentry pk-logentry-type-upd">
<span class="pk-logentry-type">upd</span>
<span class="pk-logentry-desc">BREAKING CHANGE: Minor corrections of class names for releases -> release -> logentries -> logentry.</span>
</li>
<li class="pk-logentry pk-logentry-type-upd">
<span class="pk-logentry-type">upd</span>
<span class="pk-logentry-desc">Added (most) log entry types found in "keep-a-changelog" and various log entry (commit) type aliases.</span>
</li>
<li class="pk-logentry pk-logentry-type-upd">
<span class="pk-logentry-type">upd</span>
<span class="pk-logentry-desc">BREAKING CHANGE: Field identifier (key) 'adnc' is replaced by 'audi' as an alias for 'audience'.</span>
</li>
<li class="pk-logentry pk-logentry-type-refac">
<span class="pk-logentry-type">refac</span>
<span class="pk-logentry-desc">BREAKING CHANGE: Removed class ProgressKeeper and refactored methods of ProgressKeeperInterface.</span>
</li>
<li class="pk-logentry pk-logentry-type-test">
<span class="pk-logentry-type">test</span>
<span class="pk-logentry-desc">Renaming test classes after unintentionally adding fragment 'sample' to all test cases.</span>
</li>
<li class="pk-logentry pk-logentry-type-chore">
<span class="pk-logentry-type">chore</span>
<span class="pk-logentry-desc">Consistently renamed changeLog (camelCase) to changelog (lowercase).</span>
</li>
</ul>
</div>
<div class="pk-release">
<h2 class="pk-release-version">0.1.0</h2>
<p class="pk-release-date">Date: 08.02.2018</p>
<p class="pk-release-desc">Initial release: Provides a basic factory class methods allowing a json -> html transformation.</p>
<ul class="pk-logentries">
<li class="pk-logentry pk-logentry-type-doc">
<span class="pk-logentry-type">doc</span>
<span class="pk-logentry-desc">Clarified main goals of this project + some cosmetic changes.</span>
</li>
<li class="pk-logentry pk-logentry-type-doc">
<span class="pk-logentry-type">doc</span>
<span class="pk-logentry-desc">Committing this project to the follow the principles of conventional-changelog and keep-a-changelog.</span>
</li>
<li class="pk-logentry pk-logentry-type-feat">
<span class="pk-logentry-type">feat</span>
<span class="pk-logentry-desc">Added methods for adding releases to changelogs. Object model hierarchy is now: changelog -> releases -> log entries</span>
</li>
<li class="pk-logentry pk-logentry-type-feat">
<span class="pk-logentry-type">feat</span>
<span class="pk-logentry-desc">Added methods for adding log entries to releases.</span>
</li>
<li class="pk-logentry pk-logentry-type-feat">
<span class="pk-logentry-type">feat</span>
<span class="pk-logentry-desc">Added classes representing log entries and releases.</span>
</li>
<li class="pk-logentry pk-logentry-type-feat">
<span class="pk-logentry-type">feat</span>
<span class="pk-logentry-desc">Very first sketch using a Reader/Presenter interface concept and a ProgressKeeperFactory.</span>
</li>
<li class="pk-logentry pk-logentry-type-fix">
<span class="pk-logentry-type">fix</span>
<span class="pk-logentry-desc">Only mandatory log entry fields would be correctly set by parse-from-array method.</span>
</li>
<li class="pk-logentry pk-logentry-type-chore">
<span class="pk-logentry-type">chore</span>
<span class="pk-logentry-desc">Release 0.1.0</span>
</li>
</ul>
</div>
</div>
</div>
</body>
</html>