pip-tools/towncrier.toml at main · jazzband/pip-tools · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
[tool.towncrier]
  package = "piptools"
  filename = "CHANGELOG.md"
  start_string = "<!-- towncrier release notes start -->\n"
  directory = "changelog.d/"
  title_format = ""
  template = "changelog.d/.towncrier_template.md.jinja"
  # the issue format is bare here, but then handled in the template
  # see changelog.d/.towncrier_template.md.jinja for details
  issue_format = "{issue}"
  underlines = ["", "", ""]

  [[tool.towncrier.section]]
    path = ""

  # Fully redeclare towncrier types to control names and set 'showcontent'

  [[tool.towncrier.type]]
    # A prelude to the release notes.
    directory = "highlights"
    name = "Foreword"
    showcontent = true

  [[tool.towncrier.type]]
    # Improper/undesired behavior that got corrected.
    directory = "bugfix"
    name = "Bug fixes"
    showcontent = true

  [[tool.towncrier.type]]
    # New behaviors, CLI flags, etc.
    directory = "feature"
    name = "Features"
    showcontent = true

  [[tool.towncrier.type]]
    # Declarations of future removals and breaking changes in behavior.
    directory = "deprecation"
    name = "Deprecations (removal in next major release)"
    showcontent = true

  [[tool.towncrier.type]]
    # A change in the behavior of a command, such that users may observe the
    # change purely via their usage and be negatively impacted.
    directory = "breaking"
    name = "Removals and backward incompatible breaking changes"
    showcontent = true

  [[tool.towncrier.type]]
    # Notable updates to the documentation structure or build process.
    directory = "doc"
    name = "Improved documentation"
    showcontent = true

  [[tool.towncrier.type]]
    # Notes for downstreams about unobvious side effects and tooling. Changes
    # in the test invocation considerations and runtime assumptions.
    directory = "packaging"
    name = "Packaging updates and notes for downstreams"
    showcontent = true

  [[tool.towncrier.type]]
    # Stuff that affects the contributor experience. e.g. Running tests,
    # building the docs, setting up the development environment.
    directory = "contrib"
    name = "Contributor-facing changes"
    showcontent = true

  [[tool.towncrier.type]]
    # Changes that are hard to assign to any of the above categories.
    directory = "misc"
    name = "Miscellaneous internal changes"
    showcontent = true

  [[tool.towncrier.type]]
    # A concluding paragraph after the release notes.
    directory = "afterword"
    name = "Afterword"
    showcontent = true