1.7.0

➡️  PyPI page: scriv 1.7.0.
➡️  To install: python3 -m pip install scriv==1.7.0

Added

• The GitHub release template now can use {{title}} to get the title of the changelog entry.
• The format setting is now defaulted based on the changelog setting. Previously, changelog=README.md would still use .rst formatting. Now it will use Markdown.

Changed

• Two settings have new names to better reflect what scriv does. The output_file setting is now called changelog and the insert_marker setting is now called start_marker. The old names will continue to work. Closes issue 77.

1.6.2

➡️  PyPI page: scriv 1.6.2.
➡️  To install: python3 -m pip install scriv==1.6.2

Fixed

• Replaced the invalid GitHub config key scriv.user_nick with scriv.user-nick. Fixes issue 130. Thanks, Mark Dickinson.

1.6.1

➡️  PyPI page: scriv 1.6.1.
➡️  To install: python3 -m pip install scriv==1.6.1

Fixed

• Corrected two minor packaging errors: the Mastodon badge and a typo in the short description.

1.6.0

➡️  PyPI page: scriv 1.6.0.
➡️  To install: python3 -m pip install scriv==1.6.0

Added

• Add a print command that can write changelog entries to standard out or to a file, closing issue 115. Thanks, Kurt McKee

Changed

• Dropped support for Python 3.7 and 3.8, and added 3.13.

Fixed

• A final newline is no longer stripped when rendering the new fragment template, fixing issue 108.
• Configuration setting md_header_level is allowed to be an integer in TOML files, closing issue 90. Thanks, Michael Makukha.

1.5.1

➡️  PyPI page: scriv 1.5.1.
➡️  To install: python3 -m pip install scriv==1.5.1

Fixed

• Fixed the documentation build on ReadTheDocs. Fixes issue 118.

1.5.0

➡️  PyPI page: scriv 1.5.0.
➡️  To install: python3 -m pip install scriv==1.5.0

Added

• RST to Markdown conversion can now be stricter. Using the --fail-if-warn option on the scriv github-releases command will fail the command if your RST conversion generates warnings, for example due to malformed link references.
• The scriv github-release command now has a --check-links option to check URLs. Each is fetched, and if an error occurs, warnings will show the URLs that didn't succeed.

Fixed

• Commands no longer display full tracebacks for exceptions raised by scriv code.

1.4.0

➡️  PyPI page: scriv 1.4.0.
➡️  To install: python3 -m pip install scriv==1.4.0

Added

• Literals can be extracted from .cabal files. Thanks Javier Sagredo.
• Use the git config scriv.user_nick for the user nick part of the fragment file. Thanks to Ronny Pfannschmidt, fixing issue 103.
• Settings can now be prefixed with command: to execute the rest of the setting as a shell command. The output of the command will be used as the value of the setting.

Fixed

• If there are no changelog fragments, scriv collect now exits with status code of 2, fixing issue 110.
• Changelogs with non-version headings now produce an understandable error message from scriv collect, thanks to James Gerity, fixing issue 100.

1.3.1

➡️  PyPI page: scriv 1.3.1.
➡️  To install: python3 -m pip install scriv==1.3.1

Fixed

• The Version class introduced in 1.3.0 broke the scriv github-release command. This is now fixed.

1.3.0

➡️  PyPI page: scriv 1.3.0.
➡️  To install: python3 -m pip install scriv==1.3.0

Added

• .cfg files can now be read with literal: settings, thanks to Matias Guijarro.

Fixed

• In compliance with PEP 440, comparing version numbers now ignores a leading "v" character. This makes scriv more flexible about how you present version numbers in various places (code literals, changelog entries, git tags, and so on). Fixes issue 89.

1.2.1

➡️  PyPI page: scriv 1.2.1.
➡️  To install: python3 -m pip install scriv==1.2.1

Fixed

• Scriv would fail trying to import tomllib on Python <3.11 if installed without the [toml] extra. This is now fixed, closing issue 80.
• Settings specified as file: will now search in the changelog directory and then the current directory for the file. The only exception is if the first component is . or .., then only the current directory is considered. Fixes issue 82.
• Python variables with type annotations can now be read with literal: settings, fixing issue 85.
• Error messages for mis-formed literal: configuration values are more precise, as requested in issue 84.
• Error messages from settings validation are ScrivExceptions now, and report configuration problems more clearly and earlier in some cases.