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.

1.2.0

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

Added

• scriv github-release now has a --repo= option to specify which GitHub repo to use when you have multiple remotes.

Changed

• Improved the error messages from scriv github-release when a GitHub repo can't be identified among the git remotes.

1.1.0

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

Added

• The scriv github-release command has a new setting, ghrel_template. This is a template to use when building the release text, to add text before or after the Markdown extracted from the changelog.
• The scriv github-release command now has a --dry-run option to show what would happen, without posting to GitHub.

Changed

• File names specified for file: settings will be interpreted relative to the current directory if they have path components. If the file name has no slashes or backslashes, then the old behavior remains: the file will be found in the fragment directory, or as a built-in template.
• All exceptions raised by Scriv are now ScrivException.

Fixed

• Parsing changelogs now take the insert-marker setting into account. Only content after the insert-marker line is parsed.
• More internal activities are logged, to help debug operations.

1.0.0

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

Added

• Now literal configuration settings can be read from YAML files. Closes issue 69. Thanks, Florian Küpper.

Fixed

• Fixed truncated help summaries by shortening them, closing issue 63.

0.17.0

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

Added

• The collect command now has a --title=TEXT option to provide the exact text to use as the title of the new changelog entry. Finishes issue 48.

Changed

• The github_release command now only considers the top-most entry in the changelog. You can use the --all option to continue the old behavior of making or updating GitHub releases for all of the entries.

  This change makes it easier for projects to start using scriv with an existing populated changelog file.

  Closes issue 57.

Fixed

• If there were no fragments to collect, scriv collect would make a new empty section in the changelog. This was wrong, and is now fixed. Now the changelog remains unchanged in this case. Closes issue 55.
• The github-release command will now issue a warning for changelog entries that have no version number. These can't be made into releases, so they are skipped. (issue 56).
• scriv collect will end with an error now if the version number would duplicate a version number on an existing changelog entry. Fixes issue 26.