Skip to content

Custom allbullet setting #697

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

Draft
wants to merge 6 commits into
base: trunk
Choose a base branch
from

Conversation

SmileyChris
Copy link
Contributor

@SmileyChris SmileyChris commented Mar 31, 2025

It provides a new all_bullets setting per category type that can override the global default.
This is useful if you want to have a text-only section (for example, an text introduction to the release)

Implementation Details

  • Updated fragment types loading system to support new features
  • Modified templates to handle new all_bullets configuration
  • Added tests for new functionality
  • Updated documentation to explain new features

@adiroiban
Copy link
Member

adiroiban commented Mar 31, 2025

Thanks for the PR.

This is something that I was also looking to have in towncrier.

I was thinking to have someting like 123.highlight.rst

The higlight is a special type that is rendered first and without a heading.

description make me think like this is the only / single description for a release.

With highlight you can have multiple highlights for the release.
The highlights can still be associated with an issue.

This can be currently implemented with a custom template... but maybe we can have a good default

@SmileyChris
Copy link
Contributor Author

Sure, highlight might be a better name.

This PR actually makes the existing default template respect the exsiting all_bullets setting as well, so that's a plus :)
Another small feature it adds is the ability to extend the built-in types with a custom one without having to write them all out (as shown in the docs example).

@SmileyChris
Copy link
Contributor Author

@adiroiban so at the moment, this just provides individuals to add this highlight section.

Should we just add it as a default since it's kind-of a useful thing and having a standard for it is better than people having to do it themselves?

@adiroiban
Copy link
Member

Should we just add it as a default since it's kind-of a useful thing and having a standard for it is better than people having to do it themselves?

I think that it makes sense to have this available as default and with associated documentation.

@adiroiban
Copy link
Member

@SmileyChris do you think that you will have time to work on this in the next few days?

I am planning to do a new release... and just wanted to see if I should wait for this PR.

No hurry.

Cheers

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