-
Notifications
You must be signed in to change notification settings - Fork 128
Fix regression introduced by #610 #651
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
Conversation
for more information, see https://pre-commit.ci
adiroiban
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks. Changes looks good.
I am looking at the Markdown tutorial documentation at https://towncrier.readthedocs.io/en/latest/markdown.html
and I can see that it has this config
title_format = "## [{version}](https://github.com/twisted/my-project/tree/{version}) - {project_date}"
so it looks like #610 is a bug.
Thanks again.
|
fixed while I slept. Love it! Thanks @znichollscr and @adiroiban ! |
Bumps [towncrier](https://github.com/twisted/towncrier) from 23.11.0 to 24.8.0. <details> <summary>Release notes</summary> <p><em>Sourced from <a href="https://github.com/twisted/towncrier/releases">towncrier's releases</a>.</em></p> <blockquote> <h2>Towncrier 24.8.0 (2024-08-23)</h2> <h3>Features</h3> <ul> <li>Add <code>.gitkeep</code> as an ignored filename. (<a href="https://redirect.github.com/twisted/towncrier/issues/643">#643</a>)</li> <li>Config <!-- raw HTML omitted -->ignore<!-- raw HTML omitted --> option now supports wildcard matching via <a href="https://docs.python.org/3/library/fnmatch.html#fnmatch.fnmatch">fnmatch</a>. (<a href="https://redirect.github.com/twisted/towncrier/issues/644">#644</a>)</li> <li>Add a config for enforcing issue names using regex. (<a href="https://redirect.github.com/twisted/towncrier/issues/649">#649</a>)</li> </ul> <h3>Bugfixes</h3> <ul> <li>The template file is now ignored based only on the file name. (<a href="https://redirect.github.com/twisted/towncrier/issues/638">#638</a>)</li> <li>Control of the header formatting is once again completely up to the user when they are writing markdown files (fixes a regression introduced in [#610](<a href="https://redirect.github.com/twisted/towncrier/pull/610">twisted/towncrier#610</a>)). (<a href="https://redirect.github.com/twisted/towncrier/issues/651">#651</a>)</li> <li>Fixed an issue where <!-- raw HTML omitted -->issue_template<!-- raw HTML omitted --> failed recognizing the issue name of files with a non-category suffix (<!-- raw HTML omitted -->.md<!-- raw HTML omitted -->) (<a href="https://redirect.github.com/twisted/towncrier/issues/654">#654</a>)</li> <li>Fixed a bug where orphan news fragments (e.g. +abc1234.feature) would fail when an <!-- raw HTML omitted -->issue_pattern<!-- raw HTML omitted --> is configured. Orphan news fragments are now excempt from <!-- raw HTML omitted -->issue_pattern<!-- raw HTML omitted --> checks. (<a href="https://redirect.github.com/twisted/towncrier/issues/655">#655</a>)</li> </ul> <h3>Deprecations and Removals</h3> <ul> <li> <p>Moved towncrier version definition from src/towncrier/_version.py to pyproject.toml</p> <p>towncrier.__version__ was removed, after being deprecated in 23.6.0. (<a href="https://redirect.github.com/twisted/towncrier/issues/640">#640</a>)</p> </li> </ul> <h3>Misc</h3> <ul> <li><a href="https://redirect.github.com/twisted/towncrier/issues/640">#640</a>, <a href="https://redirect.github.com/twisted/towncrier/issues/657">#657</a></li> </ul> <h2>Towncrier 24.8.0rc1 (2024-08-19)</h2> <h3>Features</h3> <ul> <li>Add <code>.gitkeep</code> as an ignored filename.</li> </ul> <!-- raw HTML omitted --> </blockquote> <p>... (truncated)</p> </details> <details> <summary>Changelog</summary> <p><em>Sourced from <a href="https://github.com/twisted/towncrier/blob/trunk/NEWS.rst">towncrier's changelog</a>.</em></p> <blockquote> <h1>Towncrier 24.8.0 (2024-08-23)</h1> <p>No changes since the previous release candidate.</p> <h2>Features</h2> <ul> <li>Add <code>.gitkeep</code> as an ignored filename. (<code>[#643](twisted/towncrier#643) <https://github.com/twisted/towncrier/issues/643></code>_)</li> <li>Config <code>ignore</code> option now supports wildcard matching via <code>fnmatch <https://docs.python.org/3/library/fnmatch.html#fnmatch.fnmatch></code><em>. (<code>[#644](twisted/towncrier#644) <https://github.com/twisted/towncrier/issues/644></code></em>)</li> <li>Add a config for enforcing issue names using regex. (<code>[#649](twisted/towncrier#649) <https://github.com/twisted/towncrier/issues/649></code>_)</li> </ul> <h2>Bugfixes</h2> <ul> <li>The template file is now ignored based only on the file name. (<code>[#638](twisted/towncrier#638) <https://github.com/twisted/towncrier/issues/638></code>_)</li> <li>Control of the header formatting is once again completely up to the user when they are writing markdown files (fixes a regression introduced in <a href="https://redirect.github.com/twisted/towncrier/pull/610">#610</a>). (<code>[#651](twisted/towncrier#651) <https://github.com/twisted/towncrier/issues/651></code>_)</li> <li>Fixed an issue where <code>issue_template</code> failed recognizing the issue name of files with a non-category suffix (<code>.md</code>) (<code>[#654](twisted/towncrier#654) <https://github.com/twisted/towncrier/issues/654></code>_)</li> <li>Fixed a bug where orphan news fragments (e.g. +abc1234.feature) would fail when an <code>issue_pattern</code> is configured. Orphan news fragments are now excempt from <code>issue_pattern</code> checks. (<code>[#655](twisted/towncrier#655) <https://github.com/twisted/towncrier/issues/655></code>_)</li> </ul> <h2>Deprecations and Removals</h2> <ul> <li> <p>Moved towncrier version definition from src/towncrier/_version.py to pyproject.toml</p> <p>towncrier.<strong>version</strong> was removed, after being deprecated in 23.6.0. (<code>[#640](twisted/towncrier#640) <https://github.com/twisted/towncrier/issues/640></code>_)</p> </li> </ul> <h2>Misc</h2> <ul> <li><code>[#640](twisted/towncrier#640) <https://github.com/twisted/towncrier/issues/640></code><em>, <code>[#657](twisted/towncrier#657) <https://github.com/twisted/towncrier/issues/657></code></em></li> </ul> <h1>Towncrier 24.7.1 (2024-07-31)</h1> <p>No significant changes since the previous release candidate.</p> <h2>Bugfixes</h2> <ul> <li>When the template file is stored in the same directory with the news fragments, it is automatically ignored when checking for valid fragment file names. (<code>[#632](twisted/towncrier#632) <https://github.com/twisted/towncrier/issues/632></code>_)</li> </ul> <p>Misc</p> <!-- raw HTML omitted --> </blockquote> <p>... (truncated)</p> </details> <details> <summary>Commits</summary> <ul> <li><a href="https://github.com/twisted/towncrier/commit/833647e31cde8fd68f0e53063b10e8f3ae4214c3"><code>833647e</code></a> Update final release.</li> <li><a href="https://github.com/twisted/towncrier/commit/f944515bd9b2c46d2cc2fc75bae35f88e4890e0d"><code>f944515</code></a> Update release docs.</li> <li><a href="https://github.com/twisted/towncrier/commit/261c8a23ec5b6a72f39230baf56698fba57bcbc9"><code>261c8a2</code></a> venv/bin/towncrier build --yes</li> <li><a href="https://github.com/twisted/towncrier/commit/89ff29cd85ed7a01868df46746fcb287d9ba5140"><code>89ff29c</code></a> Update version.</li> <li><a href="https://github.com/twisted/towncrier/commit/cb09ddf049e696c25796f8466081a66933577903"><code>cb09ddf</code></a> Remove a stray "c" in the docs (<a href="https://redirect.github.com/twisted/towncrier/issues/657">#657</a>)</li> <li><a href="https://github.com/twisted/towncrier/commit/4aa8174dc7e843e7b71fc3092216dc2915065135"><code>4aa8174</code></a> handle empty issue names (<a href="https://redirect.github.com/twisted/towncrier/issues/656">#656</a>)</li> <li><a href="https://github.com/twisted/towncrier/commit/c24e5a1bdcb7b524181d4a84cfa991b8e498e8e4"><code>c24e5a1</code></a> Update src/towncrier/test/test_check.py</li> <li><a href="https://github.com/twisted/towncrier/commit/4d1cd360bc5bfd6722ee5ef079cfbd7f7aa9e512"><code>4d1cd36</code></a> Merge branch 'trunk' of <a href="https://github.com/dorschw/towncrier">https://github.com/dorschw/towncrier</a> into trunk</li> <li><a href="https://github.com/twisted/towncrier/commit/51129c7042f0a7783cf3a6d9630bbde2fd50216c"><code>51129c7</code></a> fix comment</li> <li><a href="https://github.com/twisted/towncrier/commit/4a94d4a99f9560ee02f027f33ec41325b5bd51ab"><code>4a94d4a</code></a> Use terminology from tutorial</li> <li>Additional commits viewable in <a href="https://github.com/twisted/towncrier/compare/23.11.0...24.8.0">compare view</a></li> </ul> </details> <br /> [](https://docs.github.com/en/github/managing-security-vulnerabilities/about-dependabot-security-updates#about-compatibility-scores) Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting `@dependabot rebase`. [//]: # (dependabot-automerge-start) [//]: # (dependabot-automerge-end) --- <details> <summary>Dependabot commands and options</summary> <br /> You can trigger Dependabot actions by commenting on this PR: - `@dependabot rebase` will rebase this PR - `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it - `@dependabot merge` will merge this PR after your CI passes on it - `@dependabot squash and merge` will squash and merge this PR after your CI passes on it - `@dependabot cancel merge` will cancel a previously requested merge and block automerging - `@dependabot reopen` will reopen this PR if it is closed - `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually - `@dependabot show <dependency name> ignore conditions` will show all of the ignore conditions of the specified dependency - `@dependabot ignore this major version` will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this minor version` will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this dependency` will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself) </details> Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Bumps [towncrier](https://github.com/twisted/towncrier) from 23.11.0 to 24.8.0. <details> <summary>Release notes</summary> <p><em>Sourced from <a href="https://github.com/twisted/towncrier/releases">towncrier's releases</a>.</em></p> <blockquote> <h2>Towncrier 24.8.0 (2024-08-23)</h2> <h3>Features</h3> <ul> <li>Add <code>.gitkeep</code> as an ignored filename. (<a href="https://redirect.github.com/twisted/towncrier/issues/643">#643</a>)</li> <li>Config <!-- raw HTML omitted -->ignore<!-- raw HTML omitted --> option now supports wildcard matching via <a href="https://docs.python.org/3/library/fnmatch.html#fnmatch.fnmatch">fnmatch</a>. (<a href="https://redirect.github.com/twisted/towncrier/issues/644">#644</a>)</li> <li>Add a config for enforcing issue names using regex. (<a href="https://redirect.github.com/twisted/towncrier/issues/649">#649</a>)</li> </ul> <h3>Bugfixes</h3> <ul> <li>The template file is now ignored based only on the file name. (<a href="https://redirect.github.com/twisted/towncrier/issues/638">#638</a>)</li> <li>Control of the header formatting is once again completely up to the user when they are writing markdown files (fixes a regression introduced in [#610](<a href="https://redirect.github.com/twisted/towncrier/pull/610">twisted/towncrier#610</a>)). (<a href="https://redirect.github.com/twisted/towncrier/issues/651">#651</a>)</li> <li>Fixed an issue where <!-- raw HTML omitted -->issue_template<!-- raw HTML omitted --> failed recognizing the issue name of files with a non-category suffix (<!-- raw HTML omitted -->.md<!-- raw HTML omitted -->) (<a href="https://redirect.github.com/twisted/towncrier/issues/654">#654</a>)</li> <li>Fixed a bug where orphan news fragments (e.g. +abc1234.feature) would fail when an <!-- raw HTML omitted -->issue_pattern<!-- raw HTML omitted --> is configured. Orphan news fragments are now excempt from <!-- raw HTML omitted -->issue_pattern<!-- raw HTML omitted --> checks. (<a href="https://redirect.github.com/twisted/towncrier/issues/655">#655</a>)</li> </ul> <h3>Deprecations and Removals</h3> <ul> <li> <p>Moved towncrier version definition from src/towncrier/_version.py to pyproject.toml</p> <p>towncrier.__version__ was removed, after being deprecated in 23.6.0. (<a href="https://redirect.github.com/twisted/towncrier/issues/640">#640</a>)</p> </li> </ul> <h3>Misc</h3> <ul> <li><a href="https://redirect.github.com/twisted/towncrier/issues/640">#640</a>, <a href="https://redirect.github.com/twisted/towncrier/issues/657">#657</a></li> </ul> <h2>Towncrier 24.8.0rc1 (2024-08-19)</h2> <h3>Features</h3> <ul> <li>Add <code>.gitkeep</code> as an ignored filename.</li> </ul> <!-- raw HTML omitted --> </blockquote> <p>... (truncated)</p> </details> <details> <summary>Changelog</summary> <p><em>Sourced from <a href="https://github.com/twisted/towncrier/blob/trunk/NEWS.rst">towncrier's changelog</a>.</em></p> <blockquote> <h1>Towncrier 24.8.0 (2024-08-23)</h1> <p>No changes since the previous release candidate.</p> <h2>Features</h2> <ul> <li>Add <code>.gitkeep</code> as an ignored filename. (<code>[#643](twisted/towncrier#643) <https://github.com/twisted/towncrier/issues/643></code>_)</li> <li>Config <code>ignore</code> option now supports wildcard matching via <code>fnmatch <https://docs.python.org/3/library/fnmatch.html#fnmatch.fnmatch></code><em>. (<code>[#644](twisted/towncrier#644) <https://github.com/twisted/towncrier/issues/644></code></em>)</li> <li>Add a config for enforcing issue names using regex. (<code>[#649](twisted/towncrier#649) <https://github.com/twisted/towncrier/issues/649></code>_)</li> </ul> <h2>Bugfixes</h2> <ul> <li>The template file is now ignored based only on the file name. (<code>[#638](twisted/towncrier#638) <https://github.com/twisted/towncrier/issues/638></code>_)</li> <li>Control of the header formatting is once again completely up to the user when they are writing markdown files (fixes a regression introduced in <a href="https://redirect.github.com/twisted/towncrier/pull/610">#610</a>). (<code>[#651](twisted/towncrier#651) <https://github.com/twisted/towncrier/issues/651></code>_)</li> <li>Fixed an issue where <code>issue_template</code> failed recognizing the issue name of files with a non-category suffix (<code>.md</code>) (<code>[#654](twisted/towncrier#654) <https://github.com/twisted/towncrier/issues/654></code>_)</li> <li>Fixed a bug where orphan news fragments (e.g. +abc1234.feature) would fail when an <code>issue_pattern</code> is configured. Orphan news fragments are now excempt from <code>issue_pattern</code> checks. (<code>[#655](twisted/towncrier#655) <https://github.com/twisted/towncrier/issues/655></code>_)</li> </ul> <h2>Deprecations and Removals</h2> <ul> <li> <p>Moved towncrier version definition from src/towncrier/_version.py to pyproject.toml</p> <p>towncrier.<strong>version</strong> was removed, after being deprecated in 23.6.0. (<code>[#640](twisted/towncrier#640) <https://github.com/twisted/towncrier/issues/640></code>_)</p> </li> </ul> <h2>Misc</h2> <ul> <li><code>[#640](twisted/towncrier#640) <https://github.com/twisted/towncrier/issues/640></code><em>, <code>[#657](twisted/towncrier#657) <https://github.com/twisted/towncrier/issues/657></code></em></li> </ul> <h1>Towncrier 24.7.1 (2024-07-31)</h1> <p>No significant changes since the previous release candidate.</p> <h2>Bugfixes</h2> <ul> <li>When the template file is stored in the same directory with the news fragments, it is automatically ignored when checking for valid fragment file names. (<code>[#632](twisted/towncrier#632) <https://github.com/twisted/towncrier/issues/632></code>_)</li> </ul> <p>Misc</p> <!-- raw HTML omitted --> </blockquote> <p>... (truncated)</p> </details> <details> <summary>Commits</summary> <ul> <li><a href="https://github.com/twisted/towncrier/commit/833647e31cde8fd68f0e53063b10e8f3ae4214c3"><code>833647e</code></a> Update final release.</li> <li><a href="https://github.com/twisted/towncrier/commit/f944515bd9b2c46d2cc2fc75bae35f88e4890e0d"><code>f944515</code></a> Update release docs.</li> <li><a href="https://github.com/twisted/towncrier/commit/261c8a23ec5b6a72f39230baf56698fba57bcbc9"><code>261c8a2</code></a> venv/bin/towncrier build --yes</li> <li><a href="https://github.com/twisted/towncrier/commit/89ff29cd85ed7a01868df46746fcb287d9ba5140"><code>89ff29c</code></a> Update version.</li> <li><a href="https://github.com/twisted/towncrier/commit/cb09ddf049e696c25796f8466081a66933577903"><code>cb09ddf</code></a> Remove a stray "c" in the docs (<a href="https://redirect.github.com/twisted/towncrier/issues/657">#657</a>)</li> <li><a href="https://github.com/twisted/towncrier/commit/4aa8174dc7e843e7b71fc3092216dc2915065135"><code>4aa8174</code></a> handle empty issue names (<a href="https://redirect.github.com/twisted/towncrier/issues/656">#656</a>)</li> <li><a href="https://github.com/twisted/towncrier/commit/c24e5a1bdcb7b524181d4a84cfa991b8e498e8e4"><code>c24e5a1</code></a> Update src/towncrier/test/test_check.py</li> <li><a href="https://github.com/twisted/towncrier/commit/4d1cd360bc5bfd6722ee5ef079cfbd7f7aa9e512"><code>4d1cd36</code></a> Merge branch 'trunk' of <a href="https://github.com/dorschw/towncrier">https://github.com/dorschw/towncrier</a> into trunk</li> <li><a href="https://github.com/twisted/towncrier/commit/51129c7042f0a7783cf3a6d9630bbde2fd50216c"><code>51129c7</code></a> fix comment</li> <li><a href="https://github.com/twisted/towncrier/commit/4a94d4a99f9560ee02f027f33ec41325b5bd51ab"><code>4a94d4a</code></a> Use terminology from tutorial</li> <li>Additional commits viewable in <a href="https://github.com/twisted/towncrier/compare/23.11.0...24.8.0">compare view</a></li> </ul> </details> <br /> [](https://docs.github.com/en/github/managing-security-vulnerabilities/about-dependabot-security-updates#about-compatibility-scores) You can trigger a rebase of this PR by commenting `@dependabot rebase`. [//]: # (dependabot-automerge-start) [//]: # (dependabot-automerge-end) --- <details> <summary>Dependabot commands and options</summary> <br /> You can trigger Dependabot actions by commenting on this PR: - `@dependabot rebase` will rebase this PR - `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it - `@dependabot merge` will merge this PR after your CI passes on it - `@dependabot squash and merge` will squash and merge this PR after your CI passes on it - `@dependabot cancel merge` will cancel a previously requested merge and block automerging - `@dependabot reopen` will reopen this PR if it is closed - `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually - `@dependabot show <dependency name> ignore conditions` will show all of the ignore conditions of the specified dependency - `@dependabot ignore this major version` will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this minor version` will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this dependency` will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself) </details> > **Note** > Automatic rebases have been disabled on this pull request as it has been open for over 30 days. Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Description
Fixes #648
Checklist
src/towncrier/newsfragments/. Briefly describe yourchanges, with information useful to end users. Your change will be included in the public release notes.
docs/tutorial.rstis still up-to-date.* [ ] If you add new CLI arguments (or change the meaning of existing ones), make suredocs/cli.rstreflects those changes.docs/configuration.rstreflects those changes.