Changelog

All notable changes to this project will be documented in this file based on Keep a Changelog. This project adheres to Semantic Versioning.

Unreleased

• See upcoming changes in News directory

v0.9.0 — 2025-02-11

Breaking 🔥

• Renamed command apply to sync (#84)
• Changed configuration file root to [tool.docsub] (#85)

Added 🌿

• Support for Python 3.14, 3.13t, 3.14t (#85)

Misc

• Removed dependency on pydantic-settings (#85)

v0.8.3 — 2025-02-06

Added 🌿

• Support indented substitution blocks in markdown (#64)

v0.8.2 — 2025-02-05

Changed

• Updated importloc to 0.3+ (#71)

v0.8.1 — 2025-02-05

Fixed

• Typing errors (#65)

Misc

• Started using Just (#65)
• Added pre-commit hook (#65)
• Added tox testing matrix (#65)
• Added py.typed marker (#67)

v0.8.0 — 2025-01-18

Breaking 🔥

• Changed default config file name to docsub.toml (#58)
• Renamed ExecConfig.workdir and IncludeConfig.basedir to work_dir and base_dir (#58)
• Switch back to click (#58)

Added 🌿

• Provide temporary directory to author of project-local commands (#58)
• Developers of project-local commands can use Environment object to get temporary directory etc. (#58)
• Command line options to override config values and config file location (#58)
• Project-local commands can be executed directly with docsub x cmd-name [args] (#58)

Misc:

• Major internal refactoring (#60)

v0.7.1 — 2025-01-14

Fixed

• Duplicate newlines bug in docsub x cli command (#54)

v0.7.0 — 2025-01-14

Breaking 🔥

• Changed the way docsub is invoked: docsub apply instead of invocation without commands (#50)

Added 🌿

• New command line command docsub x (#50)

v0.6.0 — 2025-01-13

Added 🌿

• New producing command docsub: x to run commands from project-local docsubfile.py (#46)

Docs

• Updated docs (#42)

Misc

• Changed click to cyclopts (#46)

v0.5.0 — 2025-01-10

Breaking 🔥

• Completely changed syntax and command available (#36)

Added 🌿

• Logging with loguru (#11)

Docs

• Updated project metadata (#29)

Misc

• Started using docsub for self README management (#36)
• Started using pydantic-settings for settings management (#37)

v0.4.0 — 2024-12-30

Added 🌿

• docsub: sh command to substitute results of shell script execution (#7)

Misc

• Updated changelog icons (#7)

v0.3.0 — 2024-12-30

Added 🌿

• Option docsub after line N: to keep N first lines of replaced block content (#13)

Misc

• Fixed changelog URLs and release name (#25)

v0.2.0 — 2024-12-29

Breaking 🔥

• In Markdown files, docsub header is now used in one-line comment before content block, other than part of fenced code syntax (#19)

Added 🌿

• Changelog, managed by Towncrier (#12)

Changed

• Multiple heavy refactoring of logic, structure, and dev tasks; introduced multi-format modular architecture (#6)

Fixed

• Made config file .docsub.toml optional, using default command config values if missing (#3)
• Fixed regular expression bug (#5)

Docs

• Appended old Changelog entries (#17)

Misc

• Fixed dev task release bug when uv.lock file was not updated after version bump (#9)
• Minor changes related to changelog management (#17)
• Added new changelog section "Breaking" (#19)
• Add informative icons to changelog sections (#22)

v0.1.0 — 2024-12-28

Added 🌿

• Initial release (#2)