kc3-lang/libxkbcommon/towncrier.toml

Branch : - branch - android master - tag -

• Show log

  Commit

• Author : Pierre Le Marre
  Date : 2024-03-07 10:08:16
  Hash : 737706fe
  Message : doc: Use towncrier to handle release notes Towncrier is a utility to produce useful, summarized news files. See: - https://pypi.org/project/towncrier/ - https://towncrier.readthedocs.io Custom configuration for xkbcommon: - New fragments are located in the `changes` directory. - 3 sections: - API: `changes/api` - Tools: `changes/tools` - Build System: `changes/build` - 3 news fragments: - Breaking changes: `.breaking` - New: `.feature` - Fixes: `.bugfix` `NEWS` is renamed to `NEWS.md` because the tool requires `.md` extension to write in markdown format.

• towncrier.toml

• [tool.towncrier]
  name = "libxkbcommon"
  directory = "changes"
  filename = "NEWS.md"
  start_string = "<!-- towncrier release notes start -->\n"
  all_bullets = true
  single_file = true
  orphan_prefix = "+"
  underlines = ["=", "-", ""]
  title_format = "{name} [{version}](https://github.com/xkbcommon/libxkbcommon/tree/xkbcommon-{version}) - {project_date}"
  issue_format = "[#{issue}](https://github.com/xkbcommon/libxkbcommon/issues/{issue})"
  
  # Sections configuration
  
  [[tool.towncrier.section]]
  name = "API"
  path = "api"
  
  [[tool.towncrier.section]]
  name = "Tools"
  path = "tools"
  
  [[tool.towncrier.section]]
  name = "Build system"
  path = "build"
  
  # Fragments configuration
  
  [[tool.towncrier.type]]
  directory = "breaking"
  name = "Breaking changes"
  showcontent = true
  
  [[tool.towncrier.type]]
  directory = "feature"
  name = "New"
  showcontent = true
  
  [[tool.towncrier.type]]
  directory = "bugfix"
  name = "Fixes"
  showcontent = true