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

Multiple fragment types for same fragment (e.g. .bug and .bugfix) #426

Closed
MaxWinterstein opened this issue Sep 12, 2022 · 3 comments · Fixed by #622
Closed

Multiple fragment types for same fragment (e.g. .bug and .bugfix) #426

MaxWinterstein opened this issue Sep 12, 2022 · 3 comments · Fixed by #622

Comments

@MaxWinterstein
Copy link

We have multiple developers and sometimes end up with changelog files like 123.bugfix.md and 123.bug.md.

I would love to have multiple fragment types grouped together.

Currently we use some CI task to verify no unknown fragments get committed, but I would love to see this as a feature.

Configuring multiple fragment types using the same name attribute just doubles the entry in the parsed changelog file.

@adiroiban
Copy link
Member

Thanks for the feedback.

Currently we use some CI task to verify no unknown fragments get committed, but I would love to see this as a feature.

This would be nice to be part of towncrier check CLI.


I don't understand what is the issue here?

What is the expected behaviour and what is the current behaviour?


I know that sometimes, for the same work ID / ticket ID / issue ID, I need to have separate bugfix entries.

I do a hack and have 123.bugfix and 123.1.bugfix ...


Right now, the full content of a fragment file is rewrapped.

What I can think of, is that if there is an empty new line, then a separate bullet entry is created in the final NEWS file

So for a file like 123.bugfix

Description of the first bugfix
on a wrapped line.

Another description of another bugfix.

The NEWS will be like


Bugfix
------

* Description of the first bugfix on a wrapped line. [#123]
* Another description of another bugfix. [#123]


@Avasam
Copy link

Avasam commented Jul 14, 2024

Currently we use some CI task to verify no unknown fragments get committed, but I would love to see this as a feature.

Relevant: #619 (comment) And with such a check you wouldn't have incorrectly named fragments slipping through.

@adiroiban
Copy link
Member

Thanks for the update.

We have PR #622

If you have time, please consider reviewing the changes from that PR and send your feedback if the proposed fix is good enough :)

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 a pull request may close this issue.

3 participants