Skip to content

Commit d94a2a4

Browse files
committed
Add version 1.5.0
1 parent c3295f6 commit d94a2a4

File tree

1 file changed

+70
-60
lines changed

1 file changed

+70
-60
lines changed

CHANGELOG.md

Lines changed: 70 additions & 60 deletions
Original file line numberDiff line numberDiff line change
@@ -17,41 +17,51 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
1717
1818
-->
1919

20+
## 1.5.0 - 2022-10-13
21+
22+
### Added
23+
24+
* Feature: ignore pages with draft:true in meta by @Guts in <https://github.com/Guts/mkdocs-rss-plugin/pull/149>
25+
26+
### Changed
27+
28+
* Require tzdata only on Windows by @Guts in <https://github.com/Guts/mkdocs-rss-plugin/pull/148>
29+
2030
## 1.4.1 - 2022-10-07
2131

2232
### Changed
2333

24-
- Set Mkdocs upper cap to major version by @Guts in <https://github.com/Guts/mkdocs-rss-plugin/pull/146> to comply with the discussion opened by @oprypin in #137
34+
* Set Mkdocs upper cap to major version by @Guts in <https://github.com/Guts/mkdocs-rss-plugin/pull/146> to comply with the discussion opened by @oprypin in #137
2535

2636
## 1.4.0 - 2022-10-07
2737

2838
### Added
2939

30-
- Feature: add default_time option by @Guts in <https://github.com/Guts/mkdocs-rss-plugin/pull/145>
40+
* Feature: add default_time option by @Guts in <https://github.com/Guts/mkdocs-rss-plugin/pull/145>
3141

3242
### Changed
3343

34-
- Minor improvments: clean unused imports, lines length and use fstrings in logging by @Guts in <https://github.com/Guts/mkdocs-rss-plugin/pull/143>
35-
- Improvment: more granular fallback to build timestamp by @Guts in <https://github.com/Guts/mkdocs-rss-plugin/pull/144>
44+
* Minor improvments: clean unused imports, lines length and use fstrings in logging by @Guts in <https://github.com/Guts/mkdocs-rss-plugin/pull/143>
45+
* Improvment: more granular fallback to build timestamp by @Guts in <https://github.com/Guts/mkdocs-rss-plugin/pull/144>
3646

3747
## 1.3.0 - 2022-10-07
3848

3949
### Added
4050

41-
- Feature: add option to set default timezone by @Guts in <https://github.com/Guts/mkdocs-rss-plugin/pull/142>
51+
* Feature: add option to set default timezone by @Guts in <https://github.com/Guts/mkdocs-rss-plugin/pull/142>
4252

4353
## 1.2.0 - 2022-10-03
4454

4555
### Changed
4656

47-
- compatibility with Mkdocs 1.4
48-
- dependencies update
57+
* compatibility with Mkdocs 1.4
58+
* dependencies update
4959

5060
## 1.1.0 - 2022-04-27
5161

5262
### Changed
5363

54-
- switched license to MIT. (See #117)
64+
* switched license to MIT. (See #117)
5565

5666
## 1.0.0 - 2022-03-31
5767

@@ -60,258 +70,258 @@ So, no feature in this release, just focusing on quality and code cleanliness.
6070

6171
### Added
6272

63-
- Unit tests to reach a 80% coverage score
73+
* Unit tests to reach a 80% coverage score
6474

6575
### Changed
6676

67-
- Supported Mkdocs versions range increased to `mkdocs>=1.1,<1.4`
77+
* Supported Mkdocs versions range increased to `mkdocs>=1.1,<1.4`
6878

6979
### Fixed
7080

71-
- Minor bugs fixes
72-
- Minor documentation improvments
81+
* Minor bugs fixes
82+
* Minor documentation improvments
7383

7484
----
7585

7686
## 0.21.0 - 2022-02-10
7787

7888
### Added
7989

80-
- JSON Schema for configuration validation
81-
- compatible with Python 3.10
90+
* JSON Schema for configuration validation
91+
* compatible with Python 3.10
8292

8393
----
8494

8595
## 0.20.1 - 2022-02-08
8696

8797
### Fixed
8898

89-
- Error when using "enabled: false" together with "match_path" (see #104 - PR #107). Reported by @prcr, fixed by @dcode. Thanks to them!
99+
* Error when using "enabled: false" together with "match_path" (see #104 - PR #107). Reported by @prcr, fixed by @dcode. Thanks to them!
90100

91101
----
92102

93103
## 0.20.0 - 2022-01-06
94104

95105
### Added
96106

97-
- option to enable/disable the plugin, for example through an environment variable (default: enabled). See: PR #103, [related doc section](https://guts.github.io/mkdocs-rss-plugin/configuration/#disabling-the-plugin)
107+
* option to enable/disable the plugin, for example through an environment variable (default: enabled). See: PR #103, [related doc section](https://guts.github.io/mkdocs-rss-plugin/configuration/#disabling-the-plugin)
98108

99109
### Changed
100110

101-
- CI: Python version used to build and publish package is now 3.9
111+
* CI: Python version used to build and publish package is now 3.9
102112

103113
### Removed
104114

105-
- support for Python 3.6 (EOL)
115+
* support for Python 3.6 (EOL)
106116

107117
----
108118

109119
## 0.19.1 - 2021-10-04
110120

111121
### Fixed
112122

113-
- Fix #95: introduced logic did not handle case where categories meta keys are not defined
123+
* Fix #95: introduced logic did not handle case where categories meta keys are not defined
114124

115125
----
116126

117127
## 0.19.0 - 2021-10-02
118128

119129
### Added
120130

121-
- new option to include [RSS `<category>` item element](https://www.w3schools.com/xml/rss_tag_category_item.asp) using page metadata (YAML frontmatter). It's customizable to get custom meta keys for keywords/tags. PR [#4](https://github.com/Guts/mkdocs-rss-plugin/pull/4)
131+
* new option to include [RSS `<category>` item element](https://www.w3schools.com/xml/rss_tag_category_item.asp) using page metadata (YAML frontmatter). It's customizable to get custom meta keys for keywords/tags. PR [#4](https://github.com/Guts/mkdocs-rss-plugin/pull/4)
122132

123133
----
124134

125135
## 0.18.0 - 2021-09-20
126136

127137
### Added
128138

129-
- option to get the full page content into thed. Contributed by [liang2kl](https://github.com/liang2kl) with [PR 88](https://github.com/Guts/mkdocs-rss-plugin/pull/88). See the [related documentation section](https://guts.github.io/mkdocs-rss-plugin/configuration/#item-description-length).
139+
* option to get the full page content into thed. Contributed by [liang2kl](https://github.com/liang2kl) with [PR 88](https://github.com/Guts/mkdocs-rss-plugin/pull/88). See the [related documentation section](https://guts.github.io/mkdocs-rss-plugin/configuration/#item-description-length).
130140

131141
### Changed
132142

133-
- documentation on ReadTheDocs has been removed to reduce confusion and dependencies. [PR #89](https://github.com/Guts/mkdocs-rss-plugin/pull/89).
143+
* documentation on ReadTheDocs has been removed to reduce confusion and dependencies. [PR #89](https://github.com/Guts/mkdocs-rss-plugin/pull/89).
134144

135145
----
136146

137147
## 0.17.0 - 2021-06-14
138148

139149
### Changed
140150

141-
- bump MkDocs maximal version
151+
* bump MkDocs maximal version
142152

143153
### Fixed
144154

145-
- improve DockerFile used to test, fixing it after Material removed some dependencies
155+
* improve DockerFile used to test, fixing it after Material removed some dependencies
146156

147157
----
148158

149159
## 0.16.1
150160

151161
### Fixed
152162

153-
- remove a print statement
163+
* remove a print statement
154164

155165
----
156166

157167
## 0.16.0
158168

159169
### Added
160170

161-
- add option to handle the [RSS item comments element](https://www.w3schools.com/XML/rss_tag_comments.asp) through item URL path (see [documentation](https://guts.github.io/mkdocs-rss-plugin/configuration/#item-comments-path))
171+
* add option to handle the [RSS item comments element](https://www.w3schools.com/XML/rss_tag_comments.asp) through item URL path (see [documentation](https://guts.github.io/mkdocs-rss-plugin/configuration/#item-comments-path))
162172

163173
### Changed
164174

165-
- ignore `urllib.error.URLError` exception to avoid build crashes typically when network is offline
175+
* ignore `urllib.error.URLError` exception to avoid build crashes typically when network is offline
166176

167177
----
168178

169179
## 0.15.0
170180

171181
### Added
172182

173-
- ability to define URL parameters on items URLs (see [documentation](https://guts.github.io/mkdocs-rss-plugin/configuration/#url-parameters))
174-
- complete unit tests and display code coverage badge (using codecov.io)
183+
* ability to define URL parameters on items URLs (see [documentation](https://guts.github.io/mkdocs-rss-plugin/configuration/#url-parameters))
184+
* complete unit tests and display code coverage badge (using codecov.io)
175185

176186
### Changed
177187

178-
- homogenization of docstrings on the sphinx format (as stipulated in the contribution guidelines)
188+
* homogenization of docstrings on the sphinx format (as stipulated in the contribution guidelines)
179189

180190
----
181191

182192
## 0.14.0
183193

184194
### Fixed
185195

186-
- fix `match_path` option by skipping the pages that aren't included. See [PR #49](https://github.com/Guts/mkdocs-rss-plugin/pull/49). Contributed by [Paulo Ribeiro](https://github.com/pauloribeiro-codacy/).
196+
* fix `match_path` option by skipping the pages that aren't included. See [PR #49](https://github.com/Guts/mkdocs-rss-plugin/pull/49). Contributed by [Paulo Ribeiro](https://github.com/pauloribeiro-codacy/).
187197

188198
### Added
189199

190-
- add isort to development toolbelt
200+
* add isort to development toolbelt
191201

192202
----
193203

194204
## 0.13.0
195205

196206
### Added
197207

198-
- if `page.meta.description` is not set, the `abstract_chars_count` first characters from markdown content are now converted into HTML.
199-
- add `match_path` option which should be a regex pattern matching the path to your files within the docs_dir. See [issue #34](https://github.com/Guts/mkdocs-rss-plugin/issues/34) and the related [PR #43](https://github.com/Guts/mkdocs-rss-plugin/pull/43). Contributed by [Ryan Morshead](https://github.com/rmorshea/).
208+
* if `page.meta.description` is not set, the `abstract_chars_count` first characters from markdown content are now converted into HTML.
209+
* add `match_path` option which should be a regex pattern matching the path to your files within the docs_dir. See [issue #34](https://github.com/Guts/mkdocs-rss-plugin/issues/34) and the related [PR #43](https://github.com/Guts/mkdocs-rss-plugin/pull/43). Contributed by [Ryan Morshead](https://github.com/rmorshea/).
200210

201211
----
202212

203213
## 0.12.0
204214

205215
### Added
206216

207-
- add support to `page.meta.authors` or `page.meta.author` to populate feed items author tag. See [issue #34](https://github.com/Guts/mkdocs-rss-plugin/issues/34).
217+
* add support to `page.meta.authors` or `page.meta.author` to populate feed items author tag. See [issue #34](https://github.com/Guts/mkdocs-rss-plugin/issues/34).
208218

209219
----
210220

211221
## 0.11.0
212222

213223
### Added
214224

215-
- option to prettify the output, disabling minify. See [issue #18](https://github.com/Guts/mkdocs-rss-plugin/issues/18), [PR #33](https://github.com/Guts/mkdocs-rss-plugin/pull/33) and [related documentation section](https://guts.github.io/mkdocs-rss-plugin/configuration/#prettified-output)
225+
* option to prettify the output, disabling minify. See [issue #18](https://github.com/Guts/mkdocs-rss-plugin/issues/18), [PR #33](https://github.com/Guts/mkdocs-rss-plugin/pull/33) and [related documentation section](https://guts.github.io/mkdocs-rss-plugin/configuration/#prettified-output)
216226

217227
### Changed
218228

219-
- By default, the output file is now minified.
229+
* By default, the output file is now minified.
220230

221231
----
222232

223233
## 0.10.0
224234

225235
### Added
226236

227-
- option to use dates from page metadata (YAML front-matter) instead of git log. See [#14](https://github.com/Guts/mkdocs-rss-plugin/pull/14) and [related documentation section](https://guts.github.io/mkdocs-rss-plugin/configuration/#dates-overriding)
228-
- Python 3.9 is enabled in CI and referenced in PyPi tags
237+
* option to use dates from page metadata (YAML front-matter) instead of git log. See [#14](https://github.com/Guts/mkdocs-rss-plugin/pull/14) and [related documentation section](https://guts.github.io/mkdocs-rss-plugin/configuration/#dates-overriding)
238+
* Python 3.9 is enabled in CI and referenced in PyPi tags
229239

230240
### Changed
231241

232-
- the default length for description has been changed from 150 to 160 to fit maximum recommendation
242+
* the default length for description has been changed from 150 to 160 to fit maximum recommendation
233243

234244
----
235245

236246
## 0.9.0
237247

238248
### Improved
239249

240-
- enable auto-escape on feed and item titles, using the Jinja e filter - see #19
241-
- improve consistency for missing attributes in mkdocs.yml, returning almost always a None value
250+
* enable auto-escape on feed and item titles, using the Jinja e filter - see #19
251+
* improve consistency for missing attributes in mkdocs.yml, returning almost always a None value
242252

243253
----
244254

245255
## 0.8.0
246256

247257
### Added
248258

249-
- RSS compliance: image length is now present into enclosure tags - See #9
250-
- User documentation:
251-
- clarify how item elements are computed
252-
- add how to edit HTML templates meta-tags to reference feeds
253-
- API reference documentation generated from source code and published through Read The Docs
259+
* RSS compliance: image length is now present into enclosure tags - See #9
260+
* User documentation:
261+
* clarify how item elements are computed
262+
* add how to edit HTML templates meta-tags to reference feeds
263+
* API reference documentation generated from source code and published through Read The Docs
254264

255265
----
256266

257267
## 0.7.2
258268

259269
### Fixed
260270

261-
- wrong items order in updated feed
271+
* wrong items order in updated feed
262272

263273
----
264274

265275
## 0.7.1
266276

267277
### Fixed
268278

269-
- feed for updated content is broken - #15
279+
* feed for updated content is broken - #15
270280

271281
----
272282

273283
## 0.7.0
274284

275285
### Added
276286

277-
- plugin: add the `language` tag to the channel
278-
- tooling:
279-
- add first unit tests and code coverage
280-
- add Github Action to perform tests
281-
- check docker build using mkdocs-material
287+
* plugin: add the `language` tag to the channel
288+
* tooling:
289+
* add first unit tests and code coverage
290+
* add Github Action to perform tests
291+
* check docker build using mkdocs-material
282292

283293
### Changed
284294

285-
- docs: switch Feedly images from HTTP to HTTPS
295+
* docs: switch Feedly images from HTTP to HTTPS
286296

287297
----
288298

289299
## 0.6.1
290300

291301
### Fixed
292302

293-
- remove print from plugin code
303+
* remove print from plugin code
294304

295305
----
296306

297307
## 0.6.0
298308

299309
### Added
300310

301-
- plugin: add tag `guid` to the feed's items (using the page URL)
311+
* plugin: add tag `guid` to the feed's items (using the page URL)
302312

303313
### Changed
304314

305-
- docs: minor improvments
315+
* docs: minor improvments
306316

307317
----
308318

309319
## 0.5.0
310320

311321
### Added
312322

313-
- plugin: handle channel `image` and items (entries) `enclosure`
323+
* plugin: handle channel `image` and items (entries) `enclosure`
314324

315325
### Changed
316326

317-
- plugin: refactoring to build feed entry through a method
327+
* plugin: refactoring to build feed entry through a method

0 commit comments

Comments
 (0)