Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: custom section allow section titles generated by other tools #4

Draft
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

gortavoher
Copy link
Contributor

@gortavoher gortavoher commented Jun 14, 2024

Description

Add features to the library to allow:

  • the reading and writing of custom sections (H3 level headings that are not standard keep-a-changelog headlings)
  • the reading and writing of a comment placed at the end of a release section

Changes

  • refactor(token.rs): add HeadingLevel enum and use it to track heading levels in extract_tokens function
  • fix(changes.rs): keep formatting for custom section when parsing custom change kind
  • feat(changes.rs): add support for custom section in is_empty method
  • feat(changes.rs): add support for custom section in Display implementation
  • feat(parser.rs): add support for post comment in parse_footer method
  • feat(release.rs): add support for post comment in Release struct and Display implementation
  • fix(Cargo.toml): add parse-comment feature to default features
  • feat(parser.rs): add parse_comment method to Parser struct
  • feat(token.rs): add Comment variant to TokenKind enum and implement Display for it
  • feat(changelog): add support for custom sections in the CHANGELOG.md file
  • fix(changes.rs): add support for custom sections in ChangeKind and Changes structures
  • feat(Cargo.toml): add feature 'custom-section' to allow custom sections in the CHANGELOG.md file
  • test(changelog.rs): add test for reading and writing git-cliff changelog
  • feat(changelog.md): add unreleased section with features, bug fixes, refactor, testing, and miscellaneous tasks

jerusdp and others added 3 commits May 23, 2024 07:18
Write compliant markdown as validated by Markdownlint
* test(changelog.rs): add test for reading and writing git-cliff changelog
* feat(changelog.md): add unreleased section with features, bug fixes, refactor, testing, and miscellaneous tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants