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

Recent change to Towncrier generation doesn't handle newlines properly #9815

Closed
webknjaz opened this issue Apr 17, 2021 · 3 comments · Fixed by #9817
Closed

Recent change to Towncrier generation doesn't handle newlines properly #9815

webknjaz opened this issue Apr 17, 2021 · 3 comments · Fixed by #9817
Labels
good first issue A good item for first time contributors to work on state: awaiting PR Feature discussed, PR is needed type: docs Documentation related
Milestone

Comments

@webknjaz
Copy link
Member

@uranusjr I overlooked one thing — it appears that your change adding breaks the title now: https://pip--9805.org.readthedocs.build/en/9805/news/#changelog

Originally posted by @webknjaz in #9805 (comment)

@webknjaz
Copy link
Member Author

@uranusjr ☝️ just documenting this for now but the fix should be trivial — s/-}}/}}/ on the first line of the towncrier template.

@webknjaz webknjaz added good first issue A good item for first time contributors to work on state: awaiting PR Feature discussed, PR is needed skip news Does not need a NEWS file entry (eg: trivial changes) type: bug A confirmed bug or unintended behavior type: docs Documentation related type: maintenance Related to Development and Maintenance Processes type: refactor Refactoring code labels Apr 17, 2021
@pradyunsg pradyunsg changed the title [docs][bug][todo] Revert part of the news template change breaking new lines Recent change to Towncrier generation doesn't handle newlines properly Apr 17, 2021
@pradyunsg pradyunsg removed skip news Does not need a NEWS file entry (eg: trivial changes) type: bug A confirmed bug or unintended behavior type: maintenance Related to Development and Maintenance Processes type: refactor Refactoring code labels Apr 17, 2021
@sbidoul sbidoul added this to the 21.1 milestone Apr 17, 2021
This was referenced Apr 17, 2021
@uranusjr
Copy link
Member

uranusjr commented Apr 17, 2021

s/-}}/}}/ on the first line of the towncrier template.

Hmm, that does not seem to work, see #9817.

Still not right: https://pip--9817.org.readthedocs.build/en/9817/news/


Edit: I think I figured out a solution.

@webknjaz
Copy link
Member Author

Added a link to the upstream template in the PR if you want to use that: https://github.com/twisted/towncrier/blob/master/src/towncrier/templates/default.rst

webknjaz added a commit to webknjaz/setuptools that referenced this issue Apr 21, 2021
webknjaz added a commit to webknjaz/setuptools that referenced this issue Apr 25, 2021
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Sep 29, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
good first issue A good item for first time contributors to work on state: awaiting PR Feature discussed, PR is needed type: docs Documentation related
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants