Skip to content

Proper change log management with Towncrier #2201

@webknjaz

Description

@webknjaz

Here's what we need to reproduce:

  1. config for my bot for enforcing change notes: https://github.com/pypa/pip/blob/4bb2bcb/.github/chronographer.yml
  2. config for Towncrier with better sections: https://github.com/cherrypy/cheroot/blob/fdaa24d/towncrier.toml
  3. tailored gitignore: https://github.com/cherrypy/cheroot/blob/fdaa24d/docs/changelog-fragments.d/.gitignore
  4. pre-commit check: https://github.com/cherrypy/cheroot/blob/fdaa24d/.pre-commit-config.yaml#L9-L57
  5. improved changelog template with support for commit reference detection: https://github.com/cherrypy/cheroot/blob/fdaa24d/docs/changelog-fragments.d/.towncrier-template.rst.j2
  6. readme rendered within GH: https://github.com/cherrypy/cheroot/blob/fdaa24d/docs/changelog-fragments.d/README.rst
  7. tox helpers: https://github.com/cherrypy/cheroot/blob/fdaa24d/tox.ini#L278-L352
  8. integration with Sphinx:

Many of these things can be copied with minimal modifications.

Metadata

Metadata

Assignees

Labels

maintenanceRelated to maintenance processes

Type

Projects

No projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions