Debian Codegraph @

docs/changes.md

raw
1 <!--
2 SPDX-FileCopyrightText: Peter Pentchev <[email protected]>
3 SPDX-License-Identifier: BSD-2-Clause
4 -->
5
6 # Changelog
7
8 All notable changes to the feature-check project will be documented in this file.
9
10 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
11 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
12
13 ## [Unreleased]
14
15 ## [2.3.2] - 2026-03-25
16
17 ### Fixes
18
19 - Python implementation:
20 - do not test for the same base feature over and over
21 - do not bundle the `.venv` directory into the sdist tarball
22
23 ### Additions
24
25 - Python implementation:
26 - tentatively declare Python 3.15 as supported
27
28 ### Other changes
29
30 - Python implementation:
31 - use Ruff 0.15.7 with no changes
32 - allow pytest 9.x and use the `--strict` option
33 - bump some lower dependency constraints for Python 3.15 compatibility
34 - Rust implementation:
35 - drop an obsolete Clippy override
36 - note the Clippy arguments are synced with Rust 1.94
37 - use execline scripts for build testing
38 - drop the `facet-unstable` feature
39 - drop `thiserror`, implement `Display` and `Error` ourselves
40
41 ## [2.3.1] - 2025-10-10
42
43 ### Fixes
44
45 - Documentation:
46 - bump some lower version constraints to avoid a segfault with Python 3.14
47 - Rust implementation:
48 - bump the `serde` dependency to 1.0.119 to make sure consumers get compatible
49 versions of `serde` and `serde_derive`
50
51 ### Other changes
52
53 - Python implementation:
54 - refresh the `uv.lock` file
55 - Rust implementation:
56 - switch to `nom` 8.x, adapt to the `Parser` trait
57
58 ## [2.3.0] - 2025-10-08
59
60 ### Compatibility-affecting changes
61
62 - Rust implementation:
63 - bump MSRV to 1.87
64
65 ### Fixes
66
67 - Python implementation:
68 - bump the `hatchling` dependency to handle Python 3.13 and 3.14
69 - bump some dependency versions so that `uv sync --resolution=lowest` works
70 - Rust implementation:
71 - make `Version::new()` a const function
72 - bump the `serde` dependency to 1.0.115 since we use `transparent`
73 - Documentation:
74 - bump the `mkdocstrings` dependency requirement to 0.26 to fix the build
75
76 ### Additions
77
78 - Python implementation:
79 - tentatively declare Python 3.14 as supported
80 - add the `tool.uvoxen` section to the `pyproject.toml` file to allow
81 testing using the `uvoxen` tool
82 - add the `uvoxen-sync-check` test environment to make sure that
83 the `tox.ini` file is in sync with the `tool.uvoxen` definitions
84 - also keep the `uv.lock` file under version control
85 - bump some dependency versions to satisfy `uv --resolution=lowest`
86 - add the `run-uvoxen` tool to test with all supported Python versions
87 - Rust implementation:
88 - add the `facet-unstable` crate feature to allow `Version` and
89 `VersionComponent` structs to be handled using the `facet` library
90 - Documentation:
91 - add the `publync` section to the top-level `pyproject.toml` file to allow
92 `publync` to publish the documentation to the Ringlet homepage
93
94 ### Other changes
95
96 - Python implementation:
97 - move the build dependencies from a separate file into the `pyproject.toml` one
98 - use PEP 735 dependency groups instead of separate requirement files for
99 the test environments
100 - use `ruff` 0.14.0, override some more checks and reformat some source code
101 - Rust implementation:
102 - override some more Clippy lints
103 - use traits as `_` (anonymously) as possible
104 - drop the `test_` prefix for some unit test functions
105 - drop some unnecessary semicolons
106 - use the canonical name for a `Display::fmt()` implementation's parameter
107 - use `Option::then_some()`
108 - change the `#[allow(...)]` lint overrides to `#[expect(...)]` and
109 specify the reason for each one
110 - migrate to the 2024 Rust edition: reformat some `use` statements
111 - use `//` comments for the SPDX tags
112 - allow `thiserror` 2.x with no changes
113 - allow `facet` up to 0.29.x for the `facet-unstable` feature
114 - Documentation:
115 - use the `uvoxen` tool to generate and run the documentation build and
116 the SPDX tags check
117 - use `reuse` 6.x and `mkdocstrings` 0.30.x with no changes
118
119 ## [2.2.0] - 2024-07-29
120
121 ### Fixes
122
123 - Python implementation:
124 - intercept `pyparsing` errors and raise our own `ParseError` instead
125 - handle separate option values starting with a dash by switching to `click` for
126 command-line parsing
127 - Rust implementation:
128 - handle separate option values starting with a dash
129 - drop useless calls to `format!` when invoking `anyhow!` and `bail!`
130 - Testing framework:
131 - Python:
132 - use `minversion`, not `min_version`, to support Tox 3.x for a while longer
133 - add some unit tests using the `hypothesis` library
134 - Nix expressions:
135 - explicitly invoke `python3.X` instead of `python3` to make sure
136 the correct Python version is tested even if a "more preferable"
137 one is installed within the Nix environment for some reason
138
139 ### Additions
140
141 - Rust implementation:
142 - allow the `Version` struct to be deserialized if needed
143 - Testing framework:
144 - test different prefixes for the features line
145 - test for separate option values starting with a dash, e.g.
146 `feature-check -O --features`
147
148 ### Other changes
149
150 - Python implementation:
151 - let Ruff insist on trailing commas
152 - Rust implementation:
153 - simplify a couple of doc references
154 - use `clap_derive` and `serde_derive` as separate crates
155 - Documentation framework:
156 - use `mkdocstrings` 0.25 with no changes
157 - Testing framework:
158 - reuse:
159 - use reuse 4.x
160 - switch from `.reuse/dep5` to `REUSE.toml`
161 - Python:
162 - Ruff:
163 - use Ruff 0.5.5
164 - drop the obsolete `ANN101` and `BLE001` overrides
165 - globally override the `DOC501` "exception not documented in
166 the docstring" check
167 - move the base configuration to `python/ruff-base.toml` and
168 the full configuration to `python/pyproject.toml`
169 - use the concise output format even in preview mode
170 - vendor-import vetox 0.1.4
171 - Nix expressions:
172 - pass the Perl and Python versions as strings
173 - only pass the minor Perl and Python versions, we use
174 Perl 5.x and Python 3.x
175 - use `uv` and `tox-uv` in the vetox test
176 - drop the `py-ver` argument from the `perl-tap` expression
177 - use Python 3.12 and Perl 5.38 by default
178
179 ## [2.1.0] - 2024-02-10
180
181 ### Semi-incompatible changes
182
183 - Python implementation:
184 - drop support for Python 3.7, 3.8, and 3.9
185
186 ### Additions
187
188 - Start some `MkDocs` documentation and move the changelog file there.
189 - Python implementation:
190 - declare Python 3.12 and (tentatively) 3.13 as supported
191 - rename the `VersionComponent.__cmp__()` method to `cmp()`; Python 3.x has
192 never had a `__cmp__()` dunder method, so it is better to expose this one
193 - provide a `__hash__()` method for `VersionComponent`
194 - Rust implementation:
195 - implement the `IntoIterator` trait for `&Version` for easier looping
196 - Testing framework:
197 - Python:
198 - add tags to the Tox environments for the tox-stages tool
199 - add the "reuse" test environment to check the SPDX tags
200 - import the `vetox` tool for running Tox in a virtual environment and
201 add a Nix shell expression for running it with multiple Python versions
202
203 ### Other changes
204
205 - Switch to yearless copyright notices.
206 - Switch to SPDX copyright and license tags.
207 - Python implementation:
208 - minor improvements and refactoring to make use of Python 3.10's features
209 - switch from setuptools to hatchling for the PEP517 build
210 - break the installation and test requirements into separate files
211 - use Ruff's isort implementation
212 - minor improvements and refactoring suggested by Ruff 0.2.1
213 - switch from Black to Ruff for source code formatting
214 - Rust implementation:
215 - minor improvements and refactoring suggested by Clippy
216 - Clippy: allow blanket restriction lints and the question mark operator
217 - Testing framework:
218 - Python:
219 - drop the Python version from the mypy configuration, we have other
220 means of testing with multiple Python versions
221 - convert the `tox.ini` file to the Tox 4.x format
222 - drop the "flake8" and "pylint" test environments in favor of
223 the new "ruff" one
224 - use mypy 1.x, pytest 8.x, and reuse 2.x with no changes
225 - minor improvements to the Nix expressions for running the Python tests
226 - run Ruff in preview mode
227 - fcheck-testdata:
228 - use the `anyhow` and `thiserror` crates instead of `expect-exit` and `quick-error`
229 - use the `tracing` crate instead of `config-diag`
230
231 ## [2.0.0] - 2022-10-12
232
233 ### Incompatible changes
234
235 - Rust implementation:
236 - the numeric components of version strings are now unsigned (`u32`),
237 whereas before a signed integer type (`i32`) was used
238 - parse the examined program's features line into `Version` structs
239 instead of free-form strings
240 - use the `anyhow` and `thiserror` libraries instead of `quick-error`
241 and, for the command-line tool, `expect-exit`; the exported enums and
242 structs representing errors returned by the library functions have
243 been reimplemented
244 - Python implementation:
245 - use frozen dataclasses instead of reimplementing them poorly
246 - introduce the `.version.VersionComponent` and `.version.Version` classes
247 that provide an easy-to-use interface for parsing and comparing version
248 strings
249 - store a `BoolOp` object directly into the parsed `ExprOp` instead of
250 referring to the former by a string name stored in the latter
251
252 ### Semi-incompatible changes
253
254 - Python implementation:
255 - bump the minimum supported Python version to 3.7:
256 - use deferred type annotations, allowing us to use the lowercase type
257 names instead of the `typing` generics
258 - use `subprocess.run(capture_output=True)` instead of `Popen`
259 - Rust implementation:
260 - use a `Termination` trait for the `main()` exit code and specify
261 a minimum Rust version of 1.61
262
263 ### Additions
264
265 - Add an EditorConfig definitions file.
266 - Python implementation:
267 - declare Python 3.10 and 3.11 as supported versions
268 - Rust implementation:
269 - add the `run-clippy.sh` tool to run a lot of diagnostic checks
270 - Testing framework:
271 - add Nix shell expressions for running the test suites for the Perl and
272 Python implementations in a clean ("pure") Nix environment
273
274 ### Other changes
275
276 - Rust implementation:
277 - refactor a lot according to many suggestions from Clippy
278 - bump the version of the `expect-exit` dependency to 0.5 for
279 the `bool.or_exit()` implementation
280 - use a Nom-based parser for the `featurename` and `featurename op version`
281 expressions that may be specified on the command line
282 - use a Nom-based parser for the output of the examined program
283 - keep the `Cargo.lock` file under version control
284 - use the `clap` library for command-line arguments parsing
285 - Python implementation:
286 - use black 22 for source code formatting, reformat with 100 characters
287 per line
288 - move the configuration of more static checkers to the `pyproject.toml`
289 file
290 - use `pytest.mark.parametrize()` instead of `ddt` for simpler tests
291 - use a pyparsing-based parser for the `featurename` and
292 `featurename op version` expressions that may be specified on
293 the command line
294 - use a pyparsing-based parser for the output of the examined program
295 - drop a `type: ignore` comment for a bug fixed in the `mypy` tool
296 - fix the `python/3/feature-check.sh` wrapper so that it does the right
297 thing if the `PYTHONPATH` environment variable is already set
298 - Testing framework:
299 - be more permissive when looking for the program's usage message in
300 the incorrect command-line options output
301 - skip some of the program usage message tests for the Rust implementation,
302 too, since the `clap` library can format the text in different ways
303
304 ## [1.0.1] - 2021-12-17
305
306 ### Additions
307
308 - Python implementation:
309 - add tests for comparisons against beta versions of features
310 - actually install the py.typed marker file via the declarative
311 setuptools configuration
312 - Rust implementation:
313 - code clean-up:
314 - add the `html_root_url` doc attribute
315
316 ### Other changes
317
318 - Use common test definitions for the various implementations,
319 generated and kept in sync via the new fcheck-testdata internal tool.
320 - Python implementation:
321 - code clean-up:
322 - add a version to the dependency on the "hacking" Python library in
323 the tox.ini test definitions to help out pip's resolver
324 - use f-strings instead of str.format()
325 - use black's default line length of 88 characters
326 - Rust implementation:
327 - code clean-up:
328 - honor clippy's "needless borrow" suggestions
329 - drop an unused internal structure field
330 - get the crate version string from the Cargo manifest, one less place
331 to update when bumping the version
332 - move the module-level docs after the copyright notices
333 - declare compatibility with the Rust 2021 edition with no changes
334 - use the quick-error crate instead of writing boilerplate code
335
336 ## [1.0.0] - 2021-06-24
337
338 ### Incompatible changes
339
340 - Python implementation:
341 - drop Python 2.x support
342
343 ### Fixes
344
345 - Perl implementation:
346 - fix a 2 < 10 version int/string bug
347 - fix a 3.0.beta2 < 3.0 version int/string bug
348
349 ### Additions
350
351 - Add a Rust implementation.
352
353 ### Other changes
354
355 - Python implementation:
356 - rework as more idiomatic Python 3.x
357 - switch to a declarative setuptools config
358 - add a PEP 517 pyproject.toml definition
359 - reformat the source code using black
360 - push the source into a src/ subdirectory
361
362 ## [0.2.2] - 2019-01-09
363
364 ### Fixes
365
366 - Fix the Python command-line tool's use of the standard Python
367 JSON module if simplejson is not installed.
368
369 ### Other changes
370
371 - Remove two unnecessary "pass" statements since the functions
372 have a doc-string that serves as a null body.
373
374 ## [0.2.1] - 2018-11-23
375
376 ### Other changes
377
378 - Build universal Python wheels.
379 - Do not require the Python typing module, only use it when it is
380 available, e.g. during type checking tests.
381
382 ## [0.2.0] - 2018-11-22
383
384 ### Additions
385
386 - Reorganize the Python implementation:
387 - add flake8 and pylint checks
388 - add some simple unit tests
389 - add type hints
390
391 ### Other changes
392
393 - Reorganize the Python implementation:
394 - break it into modules
395
396 ## [0.1.1] - 2018-05-08
397
398 ### Fixes
399
400 - Perl 5.10 does not understand the ellipsis unimplemented statement,
401 so replace it with a die() statement with an internal error message
402
403 ## [0.1.0] - 2018-04-22
404
405 ### Started
406
407 - first public release
408
409 [Unreleased]: https://gitlab.com/ppentchev/feature-check/-/compare/release%2F2.3.2...master
410 [2.3.2]: https://gitlab.com/ppentchev/feature-check/-/compare/release%2F2.3.1...release%2F2.3.2
411 [2.3.1]: https://gitlab.com/ppentchev/feature-check/-/compare/release%2F2.3.0...release%2F2.3.1
412 [2.3.0]: https://gitlab.com/ppentchev/feature-check/-/compare/release%2F2.2.0...release%2F2.3.0
413 [2.2.0]: https://gitlab.com/ppentchev/feature-check/-/compare/release%2F2.1.0...release%2F2.2.0
414 [2.1.0]: https://gitlab.com/ppentchev/feature-check/-/compare/release%2F2.0.0...release%2F2.1.0
415 [2.0.0]: https://gitlab.com/ppentchev/feature-check/-/compare/release%2F1.0.1...release%2F2.0.0
416 [1.0.1]: https://gitlab.com/ppentchev/feature-check/-/compare/release%2F1.0.0...release%2F1.0.1
417 [1.0.0]: https://gitlab.com/ppentchev/feature-check/-/compare/release%2F0.2.2...release%2F1.0.0
418 [0.2.2]: https://gitlab.com/ppentchev/feature-check/-/compare/release%2F0.2.1...release%2F0.2.2
419 [0.2.1]: https://gitlab.com/ppentchev/feature-check/-/compare/release%2F0.2.0...release%2F0.2.1
420 [0.2.0]: https://gitlab.com/ppentchev/feature-check/-/compare/release%2F0.1.1...release%2F0.2.0
421 [0.1.1]: https://gitlab.com/ppentchev/feature-check/-/compare/release%2F0.1.0...release%2F0.1.1
422 [0.1.0]: https://gitlab.com/ppentchev/feature-check/-/tags/release%2F0.1.0