Scriv

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

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:

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

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.

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


.. _changelog-1.0.0:

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

Added
.....

- Now literal configuration settings can be read from YAML files. Closes `issue 69`_.
Thanks, `Florian Küpper <pull 70_>`_.

.. _pull 70: https://github.com/nedbat/scriv/pull/70
.. _issue 69: https://github.com/nedbat/scriv/issues/69

Fixed
.....

- Fixed truncated help summaries by shortening them, closing `issue 63`_.

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

.. _changelog-0.17.0: