Changelog¶

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

[0.6.0] - 2024-06-13¶

Breaking Change¶

• Only Gotenberg 8 is now supported

Fixed¶

• The documentation site's changelog was not updating with the changes

Added¶

• codespell pre-commit hook
• Link to the full documentation from the README
• Documentation of all implemented routes (#16)
• Page margins may now specify the units of the margin (#21)

Changed¶

• Bump codecov/codecov-action from 3 to 4 by @dependabot (#11)
• Bump release-flow/keep-a-changelog-action from 2 to 3 by @dependabot (#12)
• Bump pypa/gh-action-pypi-publish from 1.8.11 to 1.8.12 by @dependabot (#13)
• Bump pre-commit/action from 3.0.0 to 3.0.1 by @dependabot (#14)
• Bump pypa/gh-action-pypi-publish from 1.8.12 to 1.8.14 by @dependabot (#15)
• Use hatch commands for testing and linting (#17)
• Update testing Docker image to Gotenberg 8.5.0 (#18)
• chore: Formats JSON files with prettier (#19)
• chore: Updates Gotenberg test image to 8.5.1 (#20)
• chore: Updates mike to ~2.1.1 (#22)

[0.5.0] - 2024-01-11¶

Added¶

• Documentation site built with Github Pages and Material for MkDocs
• New method .run_with_retry for routes, which allows the route to be rerun as configured, with progressive backoff if the server returns a server error
• Support for Gotenberg Webhooks

Deprecated¶

• Support for Gotenberg 7.x. This will likely be the last release to support 7.x, as the options for PDF/A have been changed

[0.4.1] - 2023-12-11¶

Fixed¶

• Implemented an internal workaround for older Gotenberg versions and their handling of non-latin filenames.
• When detected, the files will be copied into a temporary directory and the filename cleaned
• Gotenberg 8.0.0 will start implementing something similar once released
• The pulled Gotenberg image is now inspected, allowing local re-creation of failures against specific digests
• The :edge tag testing is now allowed to fail

[0.4.0] - 2023-12-04¶

Changed¶

• Removed some certain special cases from coverage
• Updated pre-commit hook versions
• Updated how pytest is configured, so it will apply to any invocation
• Updated test running image to log at warning or lower using text format
• Updated test running image from 7.9.2 to 7.10.1
• For the moment, send both pdfa and pdfFormat for compatibility with 7.9 and 7.10
• See here for some subtle differences in what these options mean

Added¶

• Added new test job against Gotenberg's :edge tag

[0.3.0] - 2023-10-17¶

Added¶

• Support for the output filename and request tracing for all routes

Removed¶

• References to compression and Brotli. Gotenberg doesn't seem to ever compress response data

Fixed¶

• An issue with the sorting of merging PDFs. Expanded testing to cover the merged ordering

Changed¶

• Multiple merge calls on the same route will maintain the ordering of all files, rather than just per merge call

[0.2.0] - 2023-10-16¶

Added¶

• CodeQL scanning via GitHub
• Codecov.io coverage shield

Changed¶

• Updated pypa/gh-action-pypi-publish from 1.8.8 to 1.8.10
• Updated actions/checkout from 3 to 4
• Mis-spelled gotenerg_url for a Client is now host and no longer keyword only

[0.1.0] - 2023-10-15¶

Added¶

• Chromium conversion routes
• LibreOffice conversion routes
• PDF/A conversion route
• PDF merge route
• Health status route
• Testing and typing all setup and passing