title repeated twice when title_format is set #346

BayerSe · 2021-04-27T16:02:33Z

First of all, I would like to thank everyone working on this project. It eases our changelog generation a lot!

After upgrading our dependencies I have spotted some changed behavior. To illustrate this, I have created a fresh Python 3.9.4 project with just minimal code and towncrier==21.3.0.

When I configure towncrier like this:

[tool.towncrier]
title_format = "{version} ({project_date})"

Then the output of towncrier build --version=0.1 --draft is

0.1 (2021-04-27)
=================

Features
--------

- This is only a test. (#1)

as expected. However, the content of NEWS.rst after towncrier build --version=0.1 is

0.1 (2021-04-27)0.1 (2021-04-27)
================

Features
--------

- This is only a test. (#1)

where we can see that the title is duplicated.

The text was updated successfully, but these errors were encountered:

hynek · 2021-05-06T08:11:21Z

I suspect this is related to #340 too

Currently the title is either not rendered at all, or rendered twice cf. - twisted/towncrier#346 - twisted/towncrier#340

Workaround for twisted/towncrier#346

is fixed

saimn · 2021-08-18T21:53:52Z

We have the same issue (astropy/astropy#12083). The problem seems to be that top_line is both written by the code (

towncrier/src/towncrier/_writer.py

Lines 41 to 42 in 5dce0fa

    
           f.write(top_line.encode("utf8")) 
        
           f.write(content.encode("utf8"))

) and present in the default template. I guess it just be written only with the template.

Close pytest-dev#8817

Fixes pytest-dev#8817 Supersedes pytest-dev#9045 See twisted/towncrier#346 and twisted/towncrier#340

kasium · 2021-09-24T14:58:20Z

@adiroiban can you please release a new version with the fix

adiroiban · 2021-09-25T04:34:35Z

PR here . #360
Please check that the release candidate is ok https://pypi.org/project/towncrier/21.9.0rc1/

thanks!

See twisted/towncrier#346 Closes pytest-dev#8817, supersedes pytest-dev#9045 and pytest-dev#9046.

See twisted/towncrier#346 Closes #8817, supersedes #9045 and #9046.

decaz · 2021-11-16T15:29:43Z

@adiroiban is stable version can be released now, please?

CC @graingert @altendky @hukkin

towncrier 22.12.0 (2022-12-21) ============================== No changes since the previous release candidate. towncrier 22.12.0rc1 (2022-12-20) ================================= Features -------- - Added ``--keep`` option to the ``build`` command that allows generating a newsfile, but keeps the newsfragments in place. This option can not be used together with ``--yes``. (`#129 <https://github.com/hawkowl/towncrier/issues/129>`_) - Python 3.11 is now officially supported. (`#427 <https://github.com/hawkowl/towncrier/issues/427>`_) - You can now create fragments that are not associated with issues. Start the name of the fragment with ``+`` (e.g. ``+anything.feature``). The content of these orphan news fragments will be included in the release notes, at the end of the category corresponding to the file extension. To help quickly create a unique orphan news fragment, ``towncrier create +.feature`` will append a random string to the base name of the file, to avoid name collisions. (`#428 <https://github.com/hawkowl/towncrier/issues/428>`_) Improved Documentation ---------------------- - Improved contribution documentation. (`#415 <https://github.com/hawkowl/towncrier/issues/415>`_) - Correct a typo in the readme that incorrectly documented custom fragments in a format that does not work. (`#424 <https://github.com/hawkowl/towncrier/issues/424>`_) - The documentation has been restructured and (hopefully) improved. (`#435 <https://github.com/hawkowl/towncrier/issues/435>`_) - Added a Markdown-based how-to guide. (`#436 <https://github.com/hawkowl/towncrier/issues/436>`_) - Defining custom fragments using a TOML array is not deprecated anymore. (`#438 <https://github.com/hawkowl/towncrier/issues/438>`_) Deprecations and Removals ------------------------- - Default branch for `towncrier check` is now "origin/main" instead of "origin/master". If "origin/main" does not exist, fallback to "origin/master" with a deprecation warning. (`#400 <https://github.com/hawkowl/towncrier/issues/400>`_) Misc ---- - `#406 <https://github.com/hawkowl/towncrier/issues/406>`_, `#408 <https://github.com/hawkowl/towncrier/issues/408>`_, `#411 <https://github.com/hawkowl/towncrier/issues/411>`_, `#412 <https://github.com/hawkowl/towncrier/issues/412>`_, `#413 <https://github.com/hawkowl/towncrier/issues/413>`_, `#414 <https://github.com/hawkowl/towncrier/issues/414>`_, `#416 <https://github.com/hawkowl/towncrier/issues/416>`_, `#418 <https://github.com/hawkowl/towncrier/issues/418>`_, `#419 <https://github.com/hawkowl/towncrier/issues/419>`_, `#421 <https://github.com/hawkowl/towncrier/issues/421>`_, `#429 <https://github.com/hawkowl/towncrier/issues/429>`_, `#430 <https://github.com/hawkowl/towncrier/issues/430>`_, `#431 <https://github.com/hawkowl/towncrier/issues/431>`_, `#434 <https://github.com/hawkowl/towncrier/issues/434>`_, `#446 <https://github.com/hawkowl/towncrier/issues/446>`_, `#447 <https://github.com/hawkowl/towncrier/issues/447>`_ towncrier 22.8.0 (2022-08-29) ============================= No significant changes since the previous release candidate. towncrier 22.8.0.rc1 (2022-08-28) ================================= Features -------- - Make the check subcommand succeed for branches that change the news file This should enable the ``check`` subcommand to be used as a CI lint step and not fail when a pull request only modifies the configured news file (i.e. when the news file is being assembled for the next release). (`#337 <https://github.com/hawkowl/towncrier/issues/337>`_) - Added support to tables in toml settings, which provides a more intuitive way to configure custom types. (`#369 <https://github.com/hawkowl/towncrier/issues/369>`_) - The `towncrier create` command line now has a new `-m TEXT` argument that is used to define the content of the newly created fragment. (`#374 <https://github.com/hawkowl/towncrier/issues/374>`_) Bugfixes -------- - The extra newline between the title and rendered content when using ``--draft`` is no longer inserted. (`#105 <https://github.com/hawkowl/towncrier/issues/105>`_) - The detection of duplicate release notes was fixed and recording changes of same version is no longer triggered. Support for having the release notes for each version in a separate file is working again. This is a regression introduced in VERSION 19.9.0rc1. (`#391 <https://github.com/hawkowl/towncrier/issues/391>`_) Improved Documentation ---------------------- - Improve ``CONTRIBUTING.rst`` and add PR template. (`#342 <https://github.com/hawkowl/towncrier/issues/342>`_) - Move docs too the main branch and document custom fragment types. (`#367 <https://github.com/hawkowl/towncrier/issues/367>`_) - The CLI help messages were updated to contain more information. (`#384 <https://github.com/hawkowl/towncrier/issues/384>`_) Deprecations and Removals ------------------------- - Support for all Python versions older than 3.7 has been dropped. (`#378 <https://github.com/hawkowl/towncrier/issues/378>`_) Misc ---- - `#292 <https://github.com/hawkowl/towncrier/issues/292>`_, `#330 <https://github.com/hawkowl/towncrier/issues/330>`_, `#366 <https://github.com/hawkowl/towncrier/issues/366>`_, `#376 <https://github.com/hawkowl/towncrier/issues/376>`_, `#377 <https://github.com/hawkowl/towncrier/issues/377>`_, `#380 <https://github.com/hawkowl/towncrier/issues/380>`_, `#381 <https://github.com/hawkowl/towncrier/issues/381>`_, `#382 <https://github.com/hawkowl/towncrier/issues/382>`_, `#383 <https://github.com/hawkowl/towncrier/issues/383>`_, `#393 <https://github.com/hawkowl/towncrier/issues/393>`_, `#399 <https://github.com/hawkowl/towncrier/issues/399>`_, `#402 <https://github.com/hawkowl/towncrier/issues/402>`_ towncrier 21.9.0 (2022-02-04) ============================= Features -------- - towncrier --version` was added to the command line interface to show the product version. (`#339 <https://github.com/hawkowl/towncrier/issues/339>`_) - Support Toml v1 syntax with tomli on Python 3.6+ (`#354 <https://github.com/hawkowl/towncrier/issues/354>`_) Bugfixes -------- - Stop writing title twice when ``title_format`` is specified. (`#346 <https://github.com/hawkowl/towncrier/issues/346>`_) - Disable universal newlines when reading TOML (`#359 <https://github.com/hawkowl/towncrier/issues/359>`_) Misc ---- - `#332 <https://github.com/hawkowl/towncrier/issues/332>`_, `#333 <https://github.com/hawkowl/towncrier/issues/333>`_, `#334 <https://github.com/hawkowl/towncrier/issues/334>`_, `#338 <https://github.com/hawkowl/towncrier/issues/338>`_ towncrier 21.3.0 (2021-04-02) ============================= No significant changes since the previous release candidate. towncrier 21.3.0.rc1 (2021-03-21) ================================= Features -------- - Ticket number from file names will be stripped down to avoid ticket links such as ``#7``. (`#126 <https://github.com/hawkowl/towncrier/issues/126>`_) - Allow definition of the project ``version`` and ``name`` in the configuration file. This allows use of towncrier seamlessly with non-Python projects. (`#165 <https://github.com/hawkowl/towncrier/issues/165>`_) - Improve news fragment file name parsing to allow using file names like ``123.feature.1.ext`` which are convenient when one wants to use an appropriate extension (e.g. ``rst``, ``md``) to enable syntax highlighting. (`#173 <https://github.com/hawkowl/towncrier/issues/173>`_) - The new ``--edit`` option of the ``create`` subcommand launches an editor for entering the contents of the newsfragment. (`#275 <https://github.com/hawkowl/towncrier/issues/275>`_) - CPython 3.8 and 3.9 are now part of our automated test matrix and are officially supported. (`#291 <https://github.com/hawkowl/towncrier/issues/291>`_) - When searching for the project, first check for an existing importable instance. This helps if the version is only available in the installed version and not the source. (`#297 <https://github.com/hawkowl/towncrier/issues/297>`_) - Support building with PEP 517. (`#314 <https://github.com/hawkowl/towncrier/issues/314>`_) Bugfixes -------- - Configuration errors found during command line execution now trigger a message to stderr and no longer show a traceback. (`#84 <https://github.com/hawkowl/towncrier/issues/84>`_) - A configuration error is triggered when the newsfragment files couldn't be discovered. (`#85 <https://github.com/hawkowl/towncrier/issues/85>`_) - Invoking towncrier as `python -m towncrier` works. (`#163 <https://github.com/hawkowl/towncrier/issues/163>`_) - ``check`` subcommand defaults to UTF-8 encoding when ``sys.stdout.encoding`` is ``None``. This happens, for example, with Python 2 on GitHub Actions or when the output is piped. (`#175 <https://github.com/hawkowl/towncrier/issues/175>`_) - Specifying ``title_format`` disables default top line creation to avoid duplication. (`#180 <https://github.com/hawkowl/towncrier/issues/180>`_) Improved Documentation ---------------------- - The README now mentions the possibility to name the configuration file ``towncrier.toml`` (in addition to ``pyproject.toml``). (`#172 <https://github.com/hawkowl/towncrier/issues/172>`_) - ``start_line`` corrected to ``start_string`` in the readme to match the long standing implementation. (`#277 <https://github.com/hawkowl/towncrier/issues/277>`_) towncrier 19.9.0 (2021-03-20) ============================= No significant changes. towncrier 19.9.0rc1 (2019-09-16) ================================ Features -------- - Add ``create`` subcommand, which can be used to quickly create a news fragment command in the location defined by config. (`#4 <https://github.com/hawkowl/towncrier/issues/4>`_) - Add support for subcommands, meaning the functionality of the ``towncrier`` executable is now replaced by the ``build`` subcommand:: $ towncrier build --draft A new ``check`` subcommand is exposed. This is an alternative to calling the ``towncrier.check`` module manually:: $ towncrier check Calling ``towncrier`` without a subcommand will result in a call to the ``build`` subcommand to ensure backwards compatibility. This may be removed in a future release. (`#144 <https://github.com/hawkowl/towncrier/issues/144>`_) - Towncrier's templating now allows configuration of the version header. *CUSTOM TEMPLATE USERS PLEASE NOTE: You will need to add the version header information to your template!* (`#147 <https://github.com/hawkowl/towncrier/issues/147>`_) - towncrier now accepts the --config argument to specify a custom configuration file (`#157 <https://github.com/hawkowl/towncrier/issues/157>`_) - There is now the option for ``all_bullets = false`` in the configuration. Setting ``all_bullets`` to false means that news fragments have to include the bullet point if they should be rendered as enumerations, otherwise they are rendered directly (this means fragments can include a header.). It is necessary to set this option to avoid (incorrect) automatic indentation of multiline fragments that do not include bullet points. The ``single-file-no-bullets.rst`` template gives an example of using these options. (`#158 <https://github.com/hawkowl/towncrier/issues/158>`_) - The ``single_file`` option can now be added to the configuration file. When set to ``true``, the filename key can now be formattable with the ``name``, ``version``, and ``project_date`` format variables. This allows subsequent versions to be written out to new files instead of appended to an existing one. (`#161 <https://github.com/hawkowl/towncrier/issues/161>`_) - You can now specify Towncrier-bundled templates in your configuration file. Available templates are `default`, `hr-between-versions` (as used in attrs), and `single-file-no-bullets`. (`#162 <https://github.com/hawkowl/towncrier/issues/162>`_) Bugfixes -------- - Accept newsfragment filenames with multiple dots, like `fix-1.2.3.bugfix`. (`#142 <https://github.com/hawkowl/towncrier/issues/142>`_) Deprecations and Removals ------------------------- - The `--pyproject` option for `towncrier check` is now replaced with `--config`, for consistency with other commands. (`#162 <https://github.com/hawkowl/towncrier/issues/162>`_)

hynek mentioned this issue May 6, 2021

Towncrier stopped to render a title in version 21.3.0 #340

Closed

hynek added a commit to python-attrs/attrs that referenced this issue May 6, 2021

Pin towncrier

c5ae43f

Currently the title is either not rendered at all, or rendered twice cf. - twisted/towncrier#346 - twisted/towncrier#340

njsmith mentioned this issue May 7, 2021

When fixture setup crashes, immediately cancel all other fixture setups python-trio/pytest-trio#121

Merged

njsmith added a commit to njsmith/pytest-trio that referenced this issue May 7, 2021

Pin older version of towncrier

b338795

Workaround for twisted/towncrier#346

njsmith mentioned this issue May 7, 2021

nursery fixture is too error-prone python-trio/pytest-trio#110

Open

ericpre added a commit to ericpre/hyperspy that referenced this issue May 19, 2021

Don't specify title_format for now, revisit when twisted/towncrier#346

b6fc461

is fixed

ericpre mentioned this issue May 19, 2021

Use towncrier to generate changelog hyperspy/hyperspy#2717

Merged

4 tasks

This was referenced Jul 16, 2021

Top line is applied twice #352

Closed

Stop writing title twice when title_format is specified #356

Merged

bhrutledge mentioned this issue Jul 20, 2021

Update changelog for 3.4.2 pypa/twine#778

Merged

symonk mentioned this issue Jul 28, 2021

Figure out how to fix changelog title pytest-dev/pytest#8817

Closed

astrofrog mentioned this issue Aug 18, 2021

Fix rendered towncrier changelog to be consistent with the way towncrier does it OpenAstronomy/sphinx-changelog#12

Merged

astrofrog mentioned this issue Aug 18, 2021

remove header that causes towncrier rendering issues astropy/astropy#12083

Closed

nicoddemus added a commit to nicoddemus/pytest that referenced this issue Aug 27, 2021

Pin towncrier to 18.6.0 due to twisted/towncrier#346

16ab1d6

Close pytest-dev#8817

The-Compiler added a commit to The-Compiler/pytest that referenced this issue Aug 27, 2021

Add top line to towncrier template

2653978

Fixes pytest-dev#8817 Supersedes pytest-dev#9045 See twisted/towncrier#346 and twisted/towncrier#340

The-Compiler mentioned this issue Aug 27, 2021

Fix towncrier output pytest-dev/pytest#9046

Closed

adiroiban closed this as completed in #356 Sep 22, 2021

The-Compiler added a commit to The-Compiler/pytest that referenced this issue Nov 8, 2021

Pin towncrier to 19.9.0

38a7e70

See twisted/towncrier#346 Closes pytest-dev#8817, supersedes pytest-dev#9045 and pytest-dev#9046.

The-Compiler mentioned this issue Nov 8, 2021

Pin towncrier to 19.9.0 pytest-dev/pytest#9282

Merged

The-Compiler added a commit to pytest-dev/pytest that referenced this issue Nov 11, 2021

Pin towncrier to 19.9.0 (#9282)

17b3825

See twisted/towncrier#346 Closes #8817, supersedes #9045 and #9046.

adiroiban mentioned this issue Jun 2, 2022

title_format doesn't work in 21.9.0 #386

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

title repeated twice when title_format is set #346

title repeated twice when title_format is set #346

BayerSe commented Apr 27, 2021

hynek commented May 6, 2021

saimn commented Aug 18, 2021

kasium commented Sep 24, 2021

adiroiban commented Sep 25, 2021

decaz commented Nov 16, 2021

title repeated twice when title_format is set #346

title repeated twice when title_format is set #346

Comments

BayerSe commented Apr 27, 2021

hynek commented May 6, 2021

saimn commented Aug 18, 2021

kasium commented Sep 24, 2021

adiroiban commented Sep 25, 2021

decaz commented Nov 16, 2021