Release Notes

0.0.0

This is the first release.

New Features

  • Added a new section for deprecations that occur during a release

  • Add the ability to limit queries by stopping at an “earliest version”. This is intended to be used when scanning a branch, for example, to stop at a point when the branch was created and not include all of the history from the parent branch.

  • Add the --verbose, -v, and -q options to the command line tool for producing different levels of debug output.

  • Add a flag to collapse pre-release notes into their final release, if the final release tag is present.

  • Creating new notes files with unique names.

  • Listing the files with notes related to each release.

  • Producing a unified report of all of the notes for a release.

  • Add the sphinx extension for integration with documentation builds.

  • Support note entries that span multiple lines using preformatted syntax in YAML by prefixing the list entry with |.

    For example:

    - |
      This entry has two paragraphs.
    
      This is the second.

Upgrade Notes

  • Change the order of the slug and UUID value in the note filename so the slug comes before the UUID to make tab completion easier to use.

    Older files are still supported, and can be renamed to use the new style.

Bug Fixes

  • Resolves a bug with properly detecting pre-release versions in the existing history of a repository that resulted in some release notes not appearing in the report output.
  • Fixes bug 1522153 so that notes added in commits that are merged after tags are associated with the correct version.
  • Fixed the section used in the report to include the prelude in the output.
  • Fix bug 1517175 to ensure that all tagged versions are detected and that notes are associated with the correct version numbers.

Table Of Contents

Previous topic

Contributing

Next topic

Examples

This Page