-PhddlZddlZddlmZddlmZddlmZddlm Z ddl m Z ddl m Z ddlmZd d lmZd d lmZd d lmZmZmZmZmZGddeZdS)N)date)Path)call)dedent)patch) CliRunner)TestCase)cli)_main)readread_pkg_resourcewith_git_project with_projectwritec.eZdZdZedZdZdZedZedZ edZ ed d Z ed Z ed Z ed ZedZdZedZedZedZedZedZdZed defdZedZed dZed dZed dZed d Zed! d"Zd#Z ed$ d%Z!ed& d'Z"ed( d)Z#ed* d+Z$ed, d-Z%ed. d/Z&ed0Z'ed1 d2Z(ed3 d4Z)ed5 d6Z*ed7 d8Z+ed9 d:Z,ed;Z-ed< d=Z.ed> d?Z/ed@ dAZ0edBZ1dS)CTestCliNctdd5}|ddddn #1swxYwYtdd5}|ddddn #1swxYwYtdd5}|ddddn #1swxYwYtdd5}|d dddn #1swxYwYtd d5}|d dddn #1swxYwYtd d5}|d dddn #1swxYwYtdd5}|ddddn #1swxYwYtdd5}|ddddn #1swxYwYtdd5}|ddddn #1swxYwYtdd5}|ddddn #1swxYwYtdd5}|ddddn #1swxYwYtdd5}|ddddn #1swxYwY||gd}|d|j|j||jt ddS)Nfoo/newsfragments/123.featurewAdds levitation!foo/newsfragments/124.feature.rstExtends levitationz!foo/newsfragments/baz.feature.rstzBaz levitationz!foo/newsfragments/fix-1.2.featurezBaz fix levitationz#foo/newsfragments/+anything.featurezOrphaned featurezfoo/newsfragments/+xxx.featurezAnother orphaned featurez'foo/newsfragments/+123_orphaned.featurez*An orphaned feature starting with a numberz(foo/newsfragments/+12.3_orphaned.featurez1An orphaned feature starting with a dotted numberz'foo/newsfragments/+orphaned_123.featurez(An orphaned feature ending with a numberz(foo/newsfragments/+orphaned_12.3.featurez/An orphaned feature ending with a dotted numberzfoo/newsfragments/READMEz Blah blahzfoo/newsfragments/README.rstz **Blah blah**--draft--date 01-01-2001ra| Loading template... Finding news fragments... Rendering news fragments... Draft only -- nothing has been written. What is seen below is what would be written. Foo 1.2.3 (01-01-2001) ====================== Features -------- - Baz levitation (baz) - Baz fix levitation (fix-1.2) - Adds levitation (#123) - Extends levitation (#124) - An orphaned feature ending with a dotted number - An orphaned feature ending with a number - An orphaned feature starting with a dotted number - An orphaned feature starting with a number - Another orphaned feature - Orphaned feature )openrinvoke assertEqual exit_codeoutputr)selfcommandrunnerfresults Y/var/www/html/test/jupyter/venv/lib/python3.11/site-packages/towncrier/test/test_build.py _test_commandzTestCli._test_commandsH13 7 7 '1 GG% & & & ' ' ' ' ' ' ' ' ' ' ' ' ' ' '5s ; ; *q GG( ) ) ) * * * * * * * * * * * * * * *5s ; ; &q GG$ % % % & & & & & & & & & & & & & & &5s ; ; *q GG( ) ) ) * * * * * * * * * * * * * * *7 = = ( GG& ' ' ' ( ( ( ( ( ( ( ( ( ( ( ( ( ( ( 2C 8 8 0A GG. / / / 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 ;S A A BQ GG@ A A A B B B B B B B B B B B B B B B  ? ? ? @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ r?r@rArBrenamer r rCr!rDrEr"rFrGs r)#test_in_different_dir_config_optionz+TestCli.test_in_different_dir_config_optionsm3ii''))  ,--889JKKK + 2::<<=== ( * *  ###  ' '//0@AAA ':'7#kBRBRS    "']]- - .T"']]5G5G5L5L0M0M    F,--- z199;;<<<<??J F,--- 1488888r/ctdd5}|ddddn #1swxYwYtdd5}|ddddn #1swxYwY|tgd}|t |jt|dt|jdS)Nrrrz!foo/newsfragments/123.feature.rstrrzmultiple files for 123.feature) rrr r r!type exception ValueErrorr^rCr$r&r'r(s r)test_collisionzTestCli.test_collisionsU13 7 7 '1 GG% & & & ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' 5s ; ; *q GG( ) ) ) * * * * * * * * * * * * * * *u&I&I&IJJ f.//<<< 6F.run_order_scenariosC++--5 5 *C00%AGG   $,  "!#F,3#""     "'  "! #F*/#""       3%%%%%%%%%%%%%%%N+S117QGG5666777777777777777   '::G%/GHW%%%!&::!W"8"8"8"8#>>:!GGw$8$8$8$8999::::::::::::::::}}>>>QV%g5 5 5 5 5 5 5 5 5 5 5 5 5 5 5 5 5 5 s~GBC  G C GC 'G<D GD" "G%D" &A G3F  GF G!F "#GGGz section-az section-bztype-1ztype-2rzLoading template... Finding news fragments... Rendering news fragments... Draft only -- nothing has been written. What is seen below is what would be written. Foo 1.2.3 (01-01-2001) ======================a section-a --------- type-1 ~~~~~~ - section-a type-1 (#1) type-2 ~~~~~~ - section-a type-2 (#1) section-b --------- type-1 ~~~~~~ - section-b type-1 (#1) type-2 ~~~~~~ - section-b type-2 (#1) a section-b --------- type-2 ~~~~~~ - section-b type-2 (#1) type-1 ~~~~~~ - section-b type-1 (#1) section-a --------- type-2 ~~~~~~ - section-a type-2 (#1) type-1 ~~~~~~ - section-a type-1 (#1) N)rr!r"r#r)r$rzr(r&s @r)test_section_and_type_sortingz%TestCli.test_section_and_type_sortings 6 6 6 6 6 p$#[+$>8@TUU F,---  M ' "" & ) ) ) V$#[+$>8@TUU F,---  M ' "" & ) ) ) ) ) r/c d}d}t|d5}|ddddn #1swxYwYt|d5}|ddddn #1swxYwY|tj}|t dg}|d|j|d | d |j dS) z= If no date is passed, today's date is used. rrrrNrrrz Foo 1.2.3 ()) rrrtodayr r r!r"r^ isoformatr#)r$r&commitfragment_path1fragment_path2r'r~r(s r)test_draft_no_datezTestCli.test_draft_no_datesp 9< .# & & '! GG% & & & ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' .# & & *! GG( ) ) ) * * * * * * * * * * * * * * *  uyk22 F,--- 8EOO$5$5888&-HHHHH7;;A44A8;A8cd}d}t|d5}|ddddn #1swxYwYt|d5}|ddddn #1swxYwY||tgd}|d|jd}|tj || tj || tj |dS) Nrrrrrrrr5rr4) rrr r r!r"rFr@pathisfiler:)r$r&rrrr'r(rs r)test_no_confirmationzTestCli.test_no_confirmations8< .# & & '! GG% & & & ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' .# & & *! GG( ) ) ) * * * * * * * * * * * * * * * u&G&G&GHH F,--- t,,--- 77888 7788888rcd}d}t|d5}|ddddn #1swxYwYt|d5}|ddddn #1swxYwY||tgd}|d|j|tj d |tj ||tj |dS) z The `--keep` option will build the full final news file without deleting the fragment files and without any extra CLI interaction or confirmation. rrrrNr)rr--keeprr4) rrr r r!r"rFr@rrr$r&rrrr'r(s r)test_keep_fragmentszTestCli.test_keep_fragmentss9< .# & & '! GG% & & & ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' .# & & *! GG( ) ) ) * * * * * * * * * * * * * * * u&H&H&HII F,--- z22333 ~66777 ~6677777rcd}d}t|d5}|ddddn #1swxYwYt|d5}|ddddn #1swxYwY||tgd}|d|j|tgd }|d|jdS) aF It will fail to perform any action when the conflicting --keep and --yes options are provided. Called twice with the different order of --keep and --yes options to make sure both orders are validated since click triggers the validator in the order it parses the command line. rrrrNr)rrr5rr )rrrr5)rrr r r!r"rs r)test_yes_keep_errorzTestCli.test_yes_keep_errorsq9< .# & & '! GG% & & & ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' .# & & *! GG( ) ) ) * * * * * * * * * * * * * * * u&Q&Q&QRR F,---u&Q&Q&QRR F,-----rcd}d}t|d5}|ddddn #1swxYwYt|d5}|ddddn #1swxYwY|td5}d|_|t g}dddn #1swxYwY|d |jd }|tj ||tj ||tj |dS) z If the user says "no" to removing the newsfragements, we end up with a NEWS.rst AND the newsfragments. rrrrNrztowncrier.build.click.confirmFrr4) rrr return_valuer r r!r"rFr@rr) r$r&rrrr'mr(rs r)test_confirmation_says_noz!TestCli.test_confirmation_says_nos 9< .# & & '! GG% & & & ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' .# & & *! GG( ) ) ) * * * * * * * * * * * * * * *  2 3 3 .q"AN]]5"--F . . . . . . . . . . . . . . . F,--- t,,--- ~66777 ~6677777s07;;A44A8;A8#CC C cNt}|5|tdg}dddn #1swxYwY|d|j|j||jddS)z7 Towncrier needs a configuration file. rNr zNo configuration file found.) rrur r r!r"r#rF startswithrMs r)test_needs_configzTestCli.test_needs_configs  ' ' ) ) 7 7]]59+66F 7 7 7 7 7 7 7 7 7 7 7 7 7 7 7 F,fm<<<  001OPPQQQQQsA  AA[tool.towncrier]r&c|tdgd}|d|j|d|jdS)z{ If the configuration file doesn't specify a version or a package, the version option is required. rFrsr zError: '--version' is requiredNrarMs r)test_needs_versionzTestCli.test_needs_version sS uykEJJ F,--- 6 FFFFFr/c tdtdd5}|ddddn #1swxYwYtdd5}|ddddn #1swxYwY|t gd}|d |j||jtd  dS) zIn which a directory containing news files is built into a changelog - without a Python project or version number. We override the project title from the commandline. rqrrrNrr)--name FooBarBazrX7.8.9rrrra Loading template... Finding news fragments... Rendering news fragments... Draft only -- nothing has been written. What is seen below is what would be written. FooBarBaz 7.8.9 (01-01-2001) ============================ Features -------- - Adds levitation (#123) - Extends levitation (#124) ) runlinkrrr r r!r"r#rlstriprjs r)test_projectless_changelogz"TestCli.test_projectless_changelogs &&((( 13 7 7 '1 GG% & & & ' ' ' ' ' ' ' ' ' ' ' ' ' ' '5s ; ; *q GG( ) ) ) * * * * * * * * * * * * * * *        F,---  M   (fhh-     s#AAA/BBBz< [tool.towncrier] version = "7.8.9" ctjdtdd5}|ddddn #1swxYwY|t gd}|d|j|j||jtd dS) zCalling towncrier with version defined in configfile. Specifying a version in toml file will be helpful if version is maintained by i.e. bumpversion and it's not a python project. newsfragmentsnewsfragments/123.featurerrN)rrrr{ Loading template... Finding news fragments... Rendering news fragments... Draft only -- nothing has been written. What is seen below is what would be written. 7.8.9 (01-01-2001) ================== Features -------- - Adds levitation (#123) r@rYrrr r r!r"r#rrrjs r)test_version_in_configzTestCli.test_version_in_configNs !!! -s 3 3 'q GG% & & & ' ' ' ' ' ' ' ' ' ' ' ' ' ' 'u&I&I&IJJ F,fm<<<  M   &fhh+     AA A z? [tool.towncrier] name = "ImGoProject" ctjdtdd5}|ddddn #1swxYwY|t gd}|d|j|j||jtd dS) zThe calling towncrier with project name defined in configfile. Specifying a project name in toml file will be helpful to keep the project name consistent as part of the towncrier configuration, not call. rrrrNrXrrrrra Loading template... Finding news fragments... Rendering news fragments... Draft only -- nothing has been written. What is seen below is what would be written. ImGoProject 7.8.9 (01-01-2001) ============================== Features -------- - Adds levitation (#123) rrjs r)test_project_name_in_configz#TestCli.test_project_name_in_configys !!! -s 3 3 'q GG% & & & ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' LLL   F,fm<<<  M   &fhh+     rctjdtdd5}|ddddn #1swxYwY|t gd}|d|j|j||jtd dS) aXThe calling towncrier with any package argument. Specifying a package in the toml file or the command line should not always be needed: - we can set the version number on the command line, so we do not need the package for that. - we don't need to include the package in the changelog header. rrrrNrrrrrjs r)test_no_package_changelogz!TestCli.test_no_package_changelogs !!! -s 3 3 'q GG% & & & ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' LLL   F,fm<<<  M   &fhh+     rze [tool.towncrier] single_file=false filename="{version}-notes.rst" c fd}g}tjd||ddd||ddd|d |d j|d j|d |d j|d j|d t ttj d d | tj dtjd| tj dtjdg}|td|td||d t!d||d t!ddS)z When `single_file = false` the release notes for each version are stored in a separate file. The name of the file is defined by the `filename` configuration value. c td|d5}||dddn #1swxYwYtd|dddddg}t d|rJ|S) Nnewsfragments/rrXrrLrrr5rrr r rr;version fragment_filefragmentr'r(r&s r)do_build_once_withzHTestCli.test_release_notes_in_separate_files..do_build_once_withs6}66<< "!!! " " " " " " " " " " " " " " "]]   F<]<<==DDFF F F FM 7;;rr 123.featurer7.9.0 456.bugfix Adds catapultrr r *-notes.rstzone newfile for each buildz7.8.9-notes.rstr3z7.9.0-notes.rstz foo 7.8.9 (01-01-2001) ====================== Features -------- - Adds levitation (#123) z foo 7.9.0 (01-01-2001) ====================== Bugfixes -------- - Adds catapult (#456) N)r@rYappendr!r"r#lenrDrcwdrErFrr;listdirrrr)r$r&rresultsoutputss ` r)$test_release_notes_in_separate_filesz,TestCli.test_release_notes_in_separate_filess     ( !!!))'=BSTTUUU))'<QQRRR GAJ0'!*2CDDD GAJ0'!*2CDDD  TXZZ__]3344 5 5 (   '8992:c??KKK '8992:c??KKKt-..///t-..///  AJ   fhh   AJ   fhh r/z= [tool.towncrier] singlefile="fail!" c|t}|d|j|d|jdS)zt Failure to find the configuration file results in a clean explanation without a traceback. r z@`singlefile` is not a valid option. Did you mean `single_file`? N)r r r!r"r#rMs r)+test_singlefile_errors_and_explains_cleanlyz3TestCli.test_singlefile_errors_and_explains_cleanly#sXu%% F,---  O M     r/c Htfd}g}5tdd5}|dgddddn #1swxYwYt jd||dd d ||d d d |d|dj |dj |d|dj |dj |dtttjdd|t jdt jdt)d}||t+dddddS#1swxYwYdS)a When `single_file = true` the single file is used to store the notes for multiple versions. The name of the file is fixed as the literal option `filename` option in the configuration file, instead of extrapolated with variables. c td|d5}||dddn #1swxYwYtd|dddddgd }t d|rJ|S) NrrrXrrLrrr5Frsrrs r)rzKTestCli.test_all_version_notes_in_a_single_file..do_build_once_with@s6}66<< "!!! " " " " " " " " " " " " " " "]] "'#  F<]<<==DDFF F F FMrrPr )rz single_file=truez@ # The `filename` variable is fixed and not formated in any way.z filename="{version}-notes.rst"Nrrrrrrrrr rz"single newfile for multiple buildsz{version}-notes.rstr3ag foo 7.9.0 (01-01-2001) ====================== Bugfixes -------- - Adds catapult (#456) foo 7.8.9 (01-01-2001) ====================== Features -------- - Adds levitation (#123) )rrurrjoinr@rYrr!r"r#rrDrrrErFrr;rrrr)r$rrr'r#r&s @r)'test_all_version_notes_in_a_single_filez/TestCli.test_all_version_notes_in_a_single_file6s     *  ' ' ) )3 3 &,, II                   H_ % % % NN""7M;LMM    NN--g|_UU V V V   Q 4gaj6G H H H   Q 4gaj6G H H H   D7788994    OOBGNN+@AA2:c?? S S S/00F   &&((+   ;3 3 3 3 3 3 3 3 3 3 3 3 3 3 3 3 3 3 s5H+A3' H3A7 7H:A7 ;FHHHzp [tool.towncrier] template="towncrier:single-file-no-bullets" all_bullets=false ctjdtdd5}|ddddn #1swxYwYtdd5}|ddddn #1swxYwYtdd5}|d dddn #1swxYwYtd d5}|d dddn #1swxYwY|t gd }|d |j|jtd}||td dS)z When all_bullets is false, subsequent lines are not indented. The automatic issue number inserted by towncrier will align with the manual bullet. rrrz!wow! ~~~~ No indentation at all.Nznewsfragments/124.bugfixz#. Numbered bullet list.znewsfragments/125.removalz- Hyphen based bullet list.znewsfragments/126.docz* Asterisk based bullet list.rXrrrLrrr5rr4a foo 7.8.9 (01-01-2001) ====================== Features -------- wow! ~~~~ No indentation at all. (#123) Bugfixes -------- #. Numbered bullet list. (#124) Improved Documentation ---------------------- * Asterisk based bullet list. (#126) Deprecations and Removals ------------------------- - Hyphen based bullet list. (#125) ) r@rYrrr r r!r"r#rrr)r$r&r'r(r#s r)test_bullet_points_falsez TestCli.test_bullet_points_falses !!! -s 3 3 >DDz [tool.towncrier] package = "foo" title_format = "[{project_date}] CUSTOM RELEASE for {name} version {version}" ctdd5}|ddddn #1swxYwYtdd5}|ddddn #1swxYwY|tgd}t d}|d |j|||jdS) zD A non-empty title format adds the specified title. rrrNrrrrrXrrz 20-01-2001ra Loading template... Finding news fragments... Rendering news fragments... Draft only -- nothing has been written. What is seen below is what would be written. [20-01-2001] CUSTOM RELEASE for FooBarBaz version 7.8.9 ======================================================= Features -------- - Adds levitation (#123) - Extends levitation (#124) rrrr r rr!r"r#r$r&r'r(expected_outputs r)test_title_format_customz TestCli.test_title_format_customsh13 7 7 '1 GG% & & & ' ' ' ' ' ' ' ' ' ' ' ' ' ' '5s ; ; *q GG( ) ) ) * * * * * * * * * * * * * * *       !   , F,--- &-88888rlz [tool.towncrier] package = "foo" filename = "NEWS.md" title_format = "[{project_date}] CUSTOM RELEASE for {name} version {version}" cDtdd5}|ddddn #1swxYwY|tgd}t d}|d|j|||jdS)a A non-empty title format adds the specified title, and if the target filename is markdown then the title is added as given by the config. In this way, full control is given to the user. We make this choice for markdown files because markdown header levels depend on where in the file the section is being written and require modifications in the same line, hence there is no easy way to know what to do to get the header to be at the right level. This avoids a repeat of the regression introduced in [#610](https://github.com/twisted/towncrier/pull/610), which mistakenly assumed that starting the line with '# ' would work in all use cases. rrrNrak Loading template... Finding news fragments... Rendering news fragments... Draft only -- nothing has been written. What is seen below is what would be written. [20-01-2001] CUSTOM RELEASE for FooBarBaz version 7.8.9 ### Features - Adds levitation (#123) rrrs r)!test_title_format_custom_markdownz)TestCli.test_title_format_custom_markdowns*13 7 7 '1 GG% & & & ' ' ' ' ' ' ' ' ' ' ' ' ' ' '       !   & F,--- &-88888 377z [tool.towncrier] package = "foo" filename = "NEWS.md" title_format = "### [{project_date}] CUSTOM RELEASE for {name} version {version}" template = "custom_template.md" ctddtdddtd}td|d d  |td d gd}t dd5}|ddddn #1swxYwY|d|j|jtd}td}|||dS)at Test that we can inject markdown after some fixed header and have the injected markdown header levels set at the desired level. This avoids a repeat of the regression introduced in [#610](https://github.com/twisted/towncrier/pull/610), which mistakenly assumed that starting the line with '# ' would work in all use cases. rrNEWS.mda # Top title ## Section title Some text explaining something another line ## Release notes a footer! Tcontentsrztemplates/default.mdzcustom_template.mdz### {{ definitionsz#### {{ definitions)rrrFrsrNraw # Top title ## Section title Some text explaining something another line ## Release notes ### [01-01-2001] CUSTOM RELEASE for Foo version 1.2.3 #### Features - Adds levitation (#123) a footer! ) rrreplacer r rr!r"r#rr)r$r&default_templater(r'r#rs r)#test_markdown_injected_after_headerz+TestCli.test_markdown_injected_after_headerLso" -/@AAA #    (--CDD %--$&;    ux&>QVWW 13 7 7 '1 GG% & & & ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' F,fm<<<i    2 &11111sB((B,/B,zy [tool.towncrier] package = "foo" title_format = false template = "template.rst" cbtdd5}|tddddn #1swxYwY|tgdd}td}|d |j|||jdS) z Setting the title format to false disables the explicit title. This would be used, for example, when the template creates the title itself. template.rstra Here's a hardcoded title added by the template ============================================== {% for section in sections %} {% set underline = "-" %} {% for category, val in definitions.items() if category in sections[section] %} {% for text, values in sections[section][category]|dictsort(by='value') %} - {{ text }} {% endfor %} {% endfor %} {% endfor %} NrFrsa[ Loading template... Finding news fragments... Rendering news fragments... Draft only -- nothing has been written. What is seen below is what would be written. Here's a hardcoded title added by the template ============================================== r)rrrr r r!r"r#rs r)test_title_format_falsezTestCli.test_title_format_falses.# & & ! GG                   (    #   !     F,--- &-88888s#AAAzT [tool.towncrier] start_string="Release notes start marker" ctjdtdd5}|ddddn #1swxYwYtdd5}|ddddn #1swxYwY|t gd}|d |j|j| tj dtj d td}td }|||dS) z The `start_string` configuration is used to detect the starting point for inserting the generated release notes. A newline is automatically added to the configured value. rrrrNr4z6a line another Release notes start marker a footer! rrr3a a line another Release notes start marker foo 7.8.9 (01-01-2001) ====================== Features -------- - Adds levitation (#123) a footer! )r@rYrrr r r!r"r#rFrr;rrr)r$r&r'r(r#rs r)test_start_stringzTestCli.test_start_strings !!! -s 3 3 'q GG% & & & ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' *c " " Ta GGR S S S T T T T T T T T T T T T T T T        F,fm<<< z22BJsOODDDj!!    ( &11111s#AA A "BB Bc2tddtddd|tddgd }|d |j|jt d}td }|||d S)zS The default start string is ``.. towncrier release notes start``. rrr4z a line another .. towncrier release notes start a footer! TrrrFrsra a line another .. towncrier release notes start Foo 1.2.3 (01-01-2001) ====================== Features -------- - Adds levitation (#123) a footer! Nrr r r!r"r#rrr$r&r(r#rs r)test_default_start_stringz!TestCli.test_default_start_strings -/@AAA  ux&>QVWW F,fm<<<j!!    * &11111r/zW [tool.towncrier] package = "foo" filename = "NEWS.md" c2tddtddd|tddgd }|d |j|jt d}td }|||d S)zn The default start string is ```` for Markdown. rrrz a line another a footer! TrrrFrsrz a line another # Foo 1.2.3 (01-01-2001) ### Features - Adds levitation (#123) a footer! Nrrs r)"test_default_start_string_markdownz*TestCli.test_default_start_string_markdownEs -/@AAA  ux&>QVWW F,fm<<<i    & &11111r/z [tool.towncrier] name = "" directory = "changes" filename = "NEWS.md" version = "1.2.3" c2tddtddd|tddgd }|d |j|jt d}td }|||d S)z When configured with an empty `name` option, the default template used for Markdown renders the title of the release note with just the version number and release date. zchanges/123.featurerrz\ A line TrrrFrsrz A line # 1.2.3 (01-01-2001) ### Features - Adds levitation (#123) Nrrs r)test_markdown_no_name_titlez#TestCli.test_markdown_no_name_titleys #%6777      ux&>QVWW F,fm<<<i      &11111r/z [tool.towncrier] title_format = "{version} - {project_date}" template = "template.rst" [[tool.towncrier.type]] directory = "feature" name = "" showcontent = true c tjdtdd5}|ddddn #1swxYwYtdd5}|t ddddn #1swxYwY|t gd}t d }|d |j|j |||j dS) zP Spacing is proper when drafting with a topline and a template. rrrrNra {% for section in sections %} {% set underline = "-" %} {% for category, val in definitions.items() if category in sections[section] %} {% for text, values in sections[section][category]|dictsort(by='value') %} - {{ text }} {% endfor %} {% endfor %} {% endfor %} )--version=7.8.9z --name=foo--date=20-01-2001raC Loading template... Finding news fragments... Rendering news fragments... Draft only -- nothing has been written. What is seen below is what would be written. 7.8.9 - 20-01-2001 ================== - Adds levitation r) r@rYrrrr r r!r"r#rs r)(test_with_topline_and_template_and_draftz0TestCli.test_with_topline_and_template_and_drafts !!! -s 3 3 'q GG% & & & ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' .# & & ! GG                     $      !   " F,fm<<< &-88888s#AA A "#BBBz" [tool.towncrier] ctjdtdd5}|ddddn #1swxYwYtdd5}|ddddn #1swxYwYtdd5}|d dddn #1swxYwYtd d5}|d dddn #1swxYwY|t gd }t d }|d|j|j |||j dS) When ``showcontent`` is false (like in the ``misc`` category by default), orphans are still rendered because they don't have an issue number to display. rnewsfragments/123.miscrMiscNnewsfragments/345.misc Another miscnewsfragments/+.miscOrphan misc still displayed!newsfragments/+2.misc$Another orphan misc still displayed!rrra Loading template... Finding news fragments... Rendering news fragments... Draft only -- nothing has been written. What is seen below is what would be written. 7.8.9 (20-01-2001) ================== Misc ---- - #123, #345 - Another orphan misc still displayed! - Orphan misc still displayed! r r@rYrrr r rr!r"r#rs r)test_orphans_in_non_showcontentz'TestCli.test_orphans_in_non_showcontentsa !!! *C 0 0 A GGFOOO                *C 0 0 $A GGN # # # $ $ $ $ $ $ $ $ $ $ $ $ $ $ $ (# . . 4! GG2 3 3 3 4 4 4 4 4 4 4 4 4 4 4 4 4 4 4 )3 / / <1 GG: ; ; ; < < < < < < < < < < < < < < <      !   . F,fm<<< &-88888rzB [tool.towncrier] filename = "CHANGES.md" ctjdtdd5}|ddddn #1swxYwYtdd5}|ddddn #1swxYwYtdd5}|d dddn #1swxYwYtd d5}|d dddn #1swxYwY|t gd }t d }|d|j|j |||j dS)rrrrrNrrrrrrra Loading template... Finding news fragments... Rendering news fragments... Draft only -- nothing has been written. What is seen below is what would be written. # 7.8.9 (20-01-2001) ### Misc - #123, #345 - Another orphan misc still displayed! - Orphan misc still displayed! rrrs r)(test_orphans_in_non_showcontent_markdownz0TestCli.test_orphans_in_non_showcontent_markdown"sa !!! *C 0 0 A GGFOOO                *C 0 0 $A GGN # # # $ $ $ $ $ $ $ $ $ $ $ $ $ $ $ (# . . 4! GG2 3 3 3 4 4 4 4 4 4 4 4 4 4 4 4 4 4 4 )3 / / <1 GG: ; ; ; < < < < < < < < < < < < < < <      !   * F,fm<<< &-88888rcttdd5}|ddddn #1swxYwYtdd5}|ddddn #1swxYwY|tdd5}|ddddn #1swxYwYtd d5}|d dddn #1swxYwYtdd 5}|d dddn #1swxYwYtgd |tgd}|d|jdD]8}|tj d|d9d}| tj |t| }||tddS)z At build time, it will delete any fragment file regardless of its stage, included files that are not part of the git reporsitory, or are just staged or modified. rrz Adds levitation. File committed.Nzfoo/newsfragments/124.featurez)Extends levitation. File modified in Git.foo/newsfragments/125.featurezBaz levitation. Staged file.zfoo/newsfragments/126.featurez)Fix (literal) crash. File unknown to Git.az Extended for an hour.)gitaddrrr)123124125126zfoo/newsfragments/z.featurer4a Foo 1.2.3 (01-01-2001) ====================== Features -------- - Adds levitation. File committed. (#123) - Extends levitation. File modified in Git. Extended for an hour. (#124) - Baz levitation. Staged file. (#125) - Fix (literal) crash. File unknown to Git. (#126) )rrrr r r!r"r:r@rrrFrr)r$r&rr'r(rr news_contentss r)test_uncommitted_fileszTestCli.test_uncommitted_filesXs|13 7 7 81 GG6 7 7 7 8 8 8 8 8 8 8 8 8 8 8 8 8 8 8 13 7 7 A1 GG? @ @ @ A A A A A A A A A A A A A A A  13 7 7 41 GG2 3 3 3 4 4 4 4 4 4 4 4 4 4 4 4 4 4 4 13 7 7 A1 GG? @ @ @ A A A A A A A A A A A A A A A13 7 7 .1 GG, - - - . . . . . . . . . . . . . . . < < <===u&G&G&GHH F,---4 V VH   RW^^,S,S,S,STT U U U U t,,---T ))            sT377A00A47A4B77B;>B;C44C8;C8D11D58D5z [tool.towncrier] package = "foo" ignore = ["template.jinja", "CAPYBARAS.md", "seq_wildcard_[ab]"] ctdd5}|ddddn #1swxYwYtdd5}|ddddn #1swxYwYtdd5}|ddddn #1swxYwYtd d5}|d dddn #1swxYwYtd d5}|d dddn #1swxYwY|td g}|d|j|jdS)z When `ignore` is set in config, files with those names are ignored. Configuration supports wildcard matching with `fnmatch`. rr&This has valid filename (control case)Nz foo/newsfragments/template.jinjaz'This template has been manually ignoredzfoo/newsfragments/CAPYBARAS.mdz,This markdown file has been manually ignoredzfoo/newsfragments/.gitignorez"gitignore is automatically ignoredz foo/newsfragments/seq_wildcard_az!Manually ignored with [] wildcardrrrrr r r!r"r#rjs r)test_ignored_fileszTestCli.test_ignored_filess13 7 7 >1 GG< = = = > > > > > > > > > > > > > > > 4c : : ?a GG= > > > ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? 2C 8 8 DA GGB C C C D D D D D D D D D D D D D D D 0# 6 6 :! GG8 9 9 9 : : : : : : : : : : : : : : : 4c : : 9a GG7 8 8 8 9 9 9 9 9 9 9 9 9 9 9 9 9 9 9uyk22 F,fm<<<<1 GG< = = = > > > > > > > > > > > > > > > 13 7 7 K1 GGI J J J K K K K K K K K K K K K K K Kuyk22 F,fm<<< ?OOOOOrlz [tool.towncrier] package = "foo" template = "foo/newsfragments/template.j2" ignore = ["placeholder-to-trigger-strict-checks.txt"] ctdd5}|ddddn #1swxYwYtdd5}|ddddn #1swxYwY|tdg}|d|j|j|d |jdS) z The `template` filename is automatically ignored when it is stored in the same path as the newsfragment files. rrzBrand new thing.Nzfoo/newsfragments/template.j2a {% for section, _ in sections.items() %} {% for category, val in definitions.items() if category in sections[section]%} {{ definitions[category]['name'] }} {% for text, values in sections[section][category].items() %} - TEST {{ text }} {% endfor %} {% endfor %} {% endfor %} rrz- TEST Brand new thing. rrjs r)test_ignore_template_filenamez%TestCli.test_ignore_template_filenamesI13 7 7 (1 GG& ' ' ' ( ( ( ( ( ( ( ( ( ( ( ( ( ( ( 13 7 7 1 GG                   "uyk22 F,fm<<< 16=AAAAArlctdd5}|ddddn #1swxYwY|tgd}|d|j|jdS)z When `ignore` is not set in config, invalid filenames are skipped. This maintains backward compatibility with before we added `ignore` to the configuration spec. rrrN)rrrrXz1.0.0rr rjs r)test_no_ignore_configuredz!TestCli.test_no_ignore_configureds13 7 7 K1 GGI J J J K K K K K K K K K K K K K K K LLL   F,fm<<<<r%s# ######++++++SSSSSSSSSSSSSSW=W=W=W=W=hW=W=W=W=W=r/