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

Fix towncrier output #9046

Closed
wants to merge 2 commits into from
Closed

Conversation

The-Compiler
Copy link
Member

Add top line to towncrier template

Looks correct now:

.. towncrier release notes start

pytest 7.0.0 (2021-08-27)
=========================


Breaking Changes
----------------

- `#8246 <https://github.com/pytest-dev/pytest/issues/8246>`_: ``--version`` now writes version information to ``stdout`` rather than ``stderr``.
[...]

Fixes #8817, supersedes #9045 and also includes the changelog commit cherry-picked from there.

See twisted/towncrier#346 and twisted/towncrier#340.

Copy link
Member

@nicoddemus nicoddemus left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Awesome! 😁

@nicoddemus nicoddemus added the needs backport applied to PRs, indicates that it should be ported to the current bug-fix branch label Aug 27, 2021
@The-Compiler
Copy link
Member Author

Argh, now the docs build fails with:

/home/runner/work/pytest/pytest/doc/en/_changelog_towncrier_draft.rst:2: WARNING: Document or section may not begin with a transition.

probably because {top_line} isn't in the template. But when I add {top_line}, running towncrier manually ends up in having the version line there twice. I really don't understand how towncrier works...

@nicoddemus
Copy link
Member

nicoddemus commented Aug 27, 2021

I added the changelog entry in #9047 to get the ball rolling for 6.2.5, so you can remove that commit from here. 👍

@The-Compiler
Copy link
Member Author

Just took another look, and it looks like we will need to wait for towncrier 21.9.0: twisted/towncrier#360

Will open another PR to pin towncrier to an older version, similar to what @nicoddemus proposed.

The-Compiler added a commit to The-Compiler/pytest that referenced this pull request Nov 8, 2021
The-Compiler added a commit that referenced this pull request Nov 11, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
needs backport applied to PRs, indicates that it should be ported to the current bug-fix branch
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Figure out how to fix changelog title
2 participants