Releases: nedbat/scriv
0.15.2
➡️ PyPI page: scriv 0.15.2.
➡️ To install: python3 -m pip install scriv==0.15.2
Fixed
- Quoted commands failed, so we couldn't determine the GitHub remote.
0.15.1
➡️ PyPI page: scriv 0.15.1.
➡️ To install: python3 -m pip install scriv==0.15.1
Added
- Added docs for
scriv github-release
.
Fixed
- Call pandoc properly on Windows for the github_release command.
0.14.0
➡️ PyPI page: scriv 0.14.0.
➡️ To install: python3 -m pip install scriv==0.14.0
Added
- Add an anchor before each version section in the output of
scriv collect
so URLs for the sections are predictable and stable for each new version (Fixes issue 46). Thanks Abhilash Raj and Rodrigo Girão Serrão.
Fixed
- Markdown fragments weren't combined properly. Now they are. Thanks Rodrigo Girão Serrão.
0.13.0
➡️ PyPI page: scriv 0.13.0.
➡️ To install: python3 -m pip install scriv==0.13.0
Added
- Support finding version information in TOML files (like
pyproject.toml
) using theliteral
configuration directive. Thanks, Kurt McKee
0.12.0
➡️ PyPI page: scriv 0.12.0.
➡️ To install: python3 -m pip install scriv==0.12.0
Added
- Fragment files in the fragment directory will be skipped if they match the new configuration value
skip_fragments
, a glob pattern. The default value is "README.*". This lets you put a README.md file in that directory to explain its purpose, as requested in issue 40.
Changed
- Switched from "toml" to "tomli" for reading TOML files.
Fixed
- Setting
format=md
didn't properly cascade into other default settings, leaving you with RST settings that needed to be explicitly overridden (issue 39). This is now fixed.
0.11.0
➡️ PyPI page: scriv 0.11.0.
➡️ To install: python3 -m pip install scriv==0.11.0
Added
- A new poorly documented API is available. See the Scriv, Changelog, and Fragment classes in the scriv.scriv module.
Changed
- Python 3.6 is now the minimum supported Python version.
Fixed
- The changelog is now always written as UTF-8, regardless of the default encoding of the system. Thanks, Hei (yhlam).
0.10.0
➡️ PyPI page: scriv 0.10.0.
➡️ To install: python3 -m pip install scriv==0.10.0
Added
- Settings can now be read from a pyproject.toml file. Install with the "[toml]" extra to be sure TOML support is available. Closes issue 9.
- Added the Philosophy section of the docs.
Changed
- The default entry header no longer puts the version number in square brackets: this was a misunderstanding of the keepachangelog formatting.
- Respect the existing newline style of changelog files. (#14) This means that a changelog file with Linux newlines on a Windows platform will be updated with Linux newlines, not rewritten with Windows newlines. Thanks, Kurt McKee.
Fixed
- Support Windows' directory separator (
\
) in unit test output. (#15) This allows the unit tests to run in Windows environments. Thanks, Kurt McKee. - Explicitly specify the directories and files that Black should scan. (#16) This prevents Black from scanning every file in a virtual environment. Thanks, Kurt McKee.
- Using "literal:" values in the configuration file didn't work on Python 3.6 or 3.7, as reported in issue 18. This is now fixed.
0.9.2
➡️ PyPI page: scriv 0.9.2.
➡️ To install: python3 -m pip install scriv==0.9.2
- Packaging fix.
0.9.0
➡️ PyPI page: scriv 0.9.0.
➡️ To install: python3 -m pip install scriv==0.9.0
Added
- Markdown format is supported, both for fragments and changelog entries.
- Fragments can be mixed (some .rst and some .md). They will be collected and output in the format configured in the settings.
- Documentation.
- "python -m scriv" now works.
Changed
- The version number is displayed in the help message.
0.8.1
➡️ PyPI page: scriv 0.8.1.
➡️ To install: python3 -m pip install scriv==0.8.1
Added
- When editing a new fragment during "scriv create", if the edited fragment has no content (only comments or blank lines), then the create operation will be aborted, and the file will be removed. (Closes issue 2.)
Changed
- If the fragment directory doesn't exist, a simple direct message is shown, rather than a misleading FileNotFound error (closes issue 1).
Fixed
- When not using categories, comments in fragment files would be copied to the changelog file (issue 3). This is now fixed.
- RST syntax is better understood, so that hyperlink references and directives will be preserved. Previously, they were mistakenly interpreted as comments and discarded.