Scriv

------------------

Fixed
.....

- Fixed the documentation build on ReadTheDocs. Fixes `issue 118`_.

.. _issue 118: https://github.com/nedbat/scriv/issues/118


.. _changelog-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.


.. _changelog-1.4.0:

------------------

Added
.....

- Literals can be extracted from .cabal files.
Thanks `Javier Sagredo <pull 91_>`_.

- Use the git config ``scriv.user_nick`` for the user nick part
of the fragment file. Thanks to `Ronny Pfannschmidt <pull 106_>`_,
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 <pull 101_>`_, fixing
`issue 100`_.

.. _pull 91: https://github.com/nedbat/scriv/pull/91
.. _issue 100: https://github.com/nedbat/scriv/issues/100
.. _pull 101: https://github.com/nedbat/scriv/pull/101
.. _issue 103: https://github.com/nedbat/scriv/pull/103
.. _pull 106: https://github.com/nedbat/scriv/pull/106
.. _issue 110: https://github.com/nedbat/scriv/issues/110


.. _changelog-1.3.1:

------------------

Fixed
.....

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

.. _changelog-1.3.0:

------------------

Added
.....

- ``.cfg`` files can now be read with ``literal:`` settings, thanks to `Matias
Guijarro <pull 88_>`_.

.. _pull 88: https://github.com/nedbat/scriv/pull/88

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`_.

.. _PEP 440: https://peps.python.org/pep-0440/
.. _issue 89: https://github.com/nedbat/scriv/issues/89

.. _changelog-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.

.. _issue 80: https://github.com/nedbat/scriv/issues/80
.. _issue 82: https://github.com/nedbat/scriv/issues/82
.. _issue 84: https://github.com/nedbat/scriv/issues/84
.. _issue 85: https://github.com/nedbat/scriv/issues/85


.. _changelog-1.2.0: