bugfix in _writer.py #391
Merged
bugfix in _writer.py #391
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Thanks for the update. I only see this about single file
Can you add more info about why someone would want to use this and how to use it? Maybe the automated tests should be updated the reflect the real usage. Note I am just doing "emergency reviews" for this project. If the tests are green we can merge this PR. No problem. But if you are using the "single file" feature it would be nice to document it and make sure the automated tests will fail if any future change will introduce regressions for this feature. |
Codecov Report
@@ Coverage Diff @@
## master #391 +/- ##
==========================================
+ Coverage 97.60% 97.85% +0.25%
==========================================
Files 22 22
Lines 1334 1399 +65
Branches 130 130
==========================================
+ Hits 1302 1369 +67
+ Misses 16 15 -1
+ Partials 16 15 -1
Continue to review full report at Codecov.
|
After reading docs and source code of
However, that branch of code woule never be triggered due to the 'splitting by start_string' and writing logic afterwards.
Hope my explanation helps and booth discrepancies have been fixed in this PR. My another issue #390 has extracted related code snippets for details. |
|
@adiroiban please hold the PR, additional fixes needed |
for more information, see https://pre-commit.ci
|
@adiroiban After adding a news fragment, ci workflow passed with all success. Please check and approve the PR. https://github.com/twisted/towncrier/actions/runs/2642268377 |
adiroiban
reviewed
Jul 10, 2022
adiroiban
reviewed
Jul 10, 2022
| @@ -26,7 +26,7 @@ def append_to_newsfile( | |||
| else: | |||
| existing_content = [""] | |||
|
|
|||
| if top_line and top_line in existing_content: | |||
| if top_line and top_line in existing_content[-1]: | |||
There was a problem hiding this comment.
is this ok ?
Note that you might have a "start marker" and the version is not always at the top.
There was a problem hiding this comment.
It should be ok.
I guess you mean "start marker" as the head line "Release Notes" in front of the start_string in my test case?
Similar changelog setting also appears in the test case test_write.WritingTests.test_append_at_top_with_hint:
with open(os.path.join(tempdir, "NEWS.rst"), "w") as f:
f.write(
"Hello there! Here is some info.\n\n"
".. towncrier release notes start\nOld text.\n"
)
Whether have a "start marker" or not, the struct of single_file newsfile would be:
[start marker]
[start string]
top_line # for newer version
content # for newer version
top_line # for older version
content # for older version
...
After the clause existing_content = existing_content.split(start_string, 1), existing_content becomes a list:
[ start_marker, start_string, previous_changes ]
or just [previous_changes ].
In either case, the original predicate top_line in existing_content always fails and the supposed raise never happens. That's why I use top_line in existing_content[-1] to judge if top_line appears in previous content.
adiroiban
reviewed
Jul 10, 2022
| @@ -0,0 +1,3 @@ | |||
|
|
|||
There was a problem hiding this comment.
I think that we have 2 separate issues here.
- The detection of duplicate release notes was fixed and SOME PREVIOUS BEHAVIOUR is no longer triggered.
- Support for having the release notes for each version in a separate file is working again. This is regression introduced in VERSION X.Y.Z.
adiroiban
reviewed
Jul 10, 2022
src/towncrier/test/test_build.py
Outdated
| """ | ||
| Enabling the single file mode will write the changelog to a filename | ||
| that is formatted from the filename args. | ||
| Disabling the single file mode will write the changelog to a filename |
There was a problem hiding this comment.
I think that the docstring of the tests should be self contained and not link to the documentation.
It should explain the targeted feature, regardless of the documentation.
In some way, the docstring of this test serves as the "real" documentation :)
adiroiban
reviewed
Jul 10, 2022
src/towncrier/test/test_build.py
Outdated
Comment on lines
506
to
510
| Disabling the single file mode will write the changelog to a filename | ||
| that is formatted from the filename args, w.r.t. [documentation] | ||
| (https://towncrier.readthedocs.io/en/latest/index.html?highlight=single_file#further-options) | ||
| as: | ||
| single_file = true # if false, filename is formatted like `title_format`. |
There was a problem hiding this comment.
Suggested change
| Disabling the single file mode will write the changelog to a filename | |
| that is formatted from the filename args, w.r.t. [documentation] | |
| (https://towncrier.readthedocs.io/en/latest/index.html?highlight=single_file#further-options) | |
| as: | |
| single_file = true # if false, filename is formatted like `title_format`. | |
| 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. |
adiroiban
reviewed
Jul 10, 2022
src/towncrier/test/test_build.py
Outdated
Comment on lines
537
to
539
| f.write( | ||
| '[tool.towncrier]\n single_file=false\n filename="{version}-notes.rst"' | ||
| ) |
There was a problem hiding this comment.
A bit easier to read and I think that this part is critical for this test.
The test is big and is hard to see it's essense :)
Suggested change
| f.write( | |
| '[tool.towncrier]\n single_file=false\n filename="{version}-notes.rst"' | |
| ) | |
| f.write( | |
| '[tool.towncrier]\n' | |
| ' single_file=false\n' | |
| ' filename="{version}-notes.rst"\n' | |
| '' | |
| ) |
There was a problem hiding this comment.
It is really tedious 😂
adiroiban
reviewed
Jul 10, 2022
src/towncrier/test/test_build.py
Outdated
| @@ -500,54 +501,92 @@ def test_no_package_changelog(self): | |||
| ).lstrip(), | |||
| ) | |||
|
|
|||
| def test_single_file(self): | |||
| def test_single_file_false(self): | |||
There was a problem hiding this comment.
maybe a better description of the targeted feature
Suggested change
| def test_single_file_false(self): | |
| def test_release_notes_in_separate_files(self): |
adiroiban
reviewed
Jul 10, 2022
src/towncrier/test/test_build.py
Outdated
| @@ -568,55 +607,79 @@ def test_singlefile_errors_and_explains_cleanly(self): | |||
| result.output, | |||
| ) | |||
|
|
|||
| def test_single_file_false(self): | |||
| def test_single_file(self): | |||
There was a problem hiding this comment.
Maybe a better description for the feature
Suggested change
| def test_single_file(self): | |
| def test_all_version_notes_in_a_single_file(self): |
adiroiban
reviewed
Jul 10, 2022
src/towncrier/test/test_build.py
Outdated
| """ | ||
| If formatting arguments are given in the filename arg and single_file is | ||
| false, the filename will not be formatted. | ||
| "If a single file is used, the content of that file gets overwritten each time." |
There was a problem hiding this comment.
Suggested change
| "If a single file is used, the content of that file gets overwritten each time." | |
| When `single_file = true` the single file is used to store the notes | |
| for multiple versions. | |
| The name of the file is fixed and is not extrapolated with any variable. |
adiroiban
reviewed
Jul 10, 2022
src/towncrier/test/test_build.py
Outdated
Comment on lines
639
to
641
| f.write( | ||
| '[tool.towncrier]\n single_file=true\n filename="{version}-notes.rst"' | ||
| ) |
There was a problem hiding this comment.
I think that this is the important part.
Suggested change
| f.write( | |
| '[tool.towncrier]\n single_file=true\n filename="{version}-notes.rst"' | |
| ) | |
| f.write( | |
| '[tool.towncrier]\n' | |
| ' single_file=true\n' | |
| ' # The `filename` variable is fixed and not formated\n` | |
| ' # in any way.\n' | |
| ' filename="{version}-notes.rst"\n | |
| '' | |
| ) |
adiroiban
requested changes
Jul 10, 2022
There was a problem hiding this comment.
Changes for the single_file looks good.
The variable name is confusing :( ... so dedicated documentation should help a lot.
This needs-changes and I am not sure that the if top_line and top_line in existing_content[-1]: change is ok.
Do we have tests for this?
Was any of the existing test failing?
Maybe have this in a separate PR.
Thanks again
|
@adiroiban All suggested changes in upon comments have been updated, and a detailed explanation about Question about All existing tests passed in the workflow. |
adiroiban
approved these changes
Jul 11, 2022
|
glad to make a contribution to towncrier :) |
bors bot
added a commit
to microsoft/Qcodes
that referenced
this pull request
Sep 6, 2022
4559: Update towncrier requirement from ~=21.9.0 to ~=22.8.0 r=jenshnielsen a=dependabot[bot] Updates the requirements on [towncrier](https://github.com/hawkowl/towncrier) to permit the latest version. <details> <summary>Release notes</summary> <p><em>Sourced from <a href="https://github.com/hawkowl/towncrier/releases">towncrier's releases</a>.</em></p> <blockquote> <h2>Towncrier 22.8.0</h2> <h1>towncrier 22.8.0 (2022-08-29)</h1> <p>No significant changes since the previous release candidate.</p> <h1>towncrier 22.8.0.rc1 (2022-08-28)</h1> <h2>Features</h2> <ul> <li> <p>Make the check subcommand succeed for branches that change the news file</p> <p>This should enable the <code>check</code> 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). (<code>[#337](twisted/towncrier#337) <https://github.com/hawkowl/towncrier/issues/337></code>_)</p> </li> <li> <p>Added support to tables in toml settings, which provides a more intuitive way to configure custom types. (<code>[#369](twisted/towncrier#369) <https://github.com/hawkowl/towncrier/issues/369></code>_)</p> </li> <li> <p>The <code>towncrier create</code> command line now has a new <code>-m TEXT</code> argument that is used to define the content of the newly created fragment. (<code>[#374](twisted/towncrier#374) <https://github.com/hawkowl/towncrier/issues/374></code>_)</p> </li> </ul> <h2>Bugfixes</h2> <ul> <li> <p>The extra newline between the title and rendered content when using <code>--draft</code> is no longer inserted. (<code>[#105](twisted/towncrier#105) <https://github.com/hawkowl/towncrier/issues/105></code>_)</p> </li> <li> <p>The detection of duplicate release notes was fixed and recording changes of same version is no longer triggered.</p> <p>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. (<code>[#391](twisted/towncrier#391) <https://github.com/hawkowl/towncrier/issues/391></code>_)</p> </li> </ul> <h2>Improved Documentation</h2> <ul> <li>Improve <code>CONTRIBUTING.rst</code> and add PR template. (<code>[#342](twisted/towncrier#342) <https://github.com/hawkowl/towncrier/issues/342></code>_)</li> <li>Move docs too the main branch and document custom fragment types. (<code>[#367](twisted/towncrier#367) <https://github.com/hawkowl/towncrier/issues/367></code>_)</li> <li>The CLI help messages were updated to contain more information. (<code>[#384](twisted/towncrier#384) <https://github.com/hawkowl/towncrier/issues/384></code>_)</li> </ul> <h2>Deprecations and Removals</h2> <ul> <li>Support for all Python versions older than 3.7 has been dropped. (<code>[#378](twisted/towncrier#378) <https://github.com/hawkowl/towncrier/issues/378></code>_)</li> </ul> </blockquote> </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 22.8.0 (2022-08-29)</h1> <p>No significant changes since the previous release candidate.</p> <h1>towncrier 22.8.0.rc1 (2022-08-28)</h1> <h2>Features</h2> <ul> <li> <p>Make the check subcommand succeed for branches that change the news file</p> <p>This should enable the <code>check</code> 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). (<code>[#337](twisted/towncrier#337) <https://github.com/hawkowl/towncrier/issues/337></code>_)</p> </li> <li> <p>Added support to tables in toml settings, which provides a more intuitive way to configure custom types. (<code>[#369](twisted/towncrier#369) <https://github.com/hawkowl/towncrier/issues/369></code>_)</p> </li> <li> <p>The <code>towncrier create</code> command line now has a new <code>-m TEXT</code> argument that is used to define the content of the newly created fragment. (<code>[#374](twisted/towncrier#374) <https://github.com/hawkowl/towncrier/issues/374></code>_)</p> </li> </ul> <h2>Bugfixes</h2> <ul> <li> <p>The extra newline between the title and rendered content when using <code>--draft</code> is no longer inserted. (<code>[#105](twisted/towncrier#105) <https://github.com/hawkowl/towncrier/issues/105></code>_)</p> </li> <li> <p>The detection of duplicate release notes was fixed and recording changes of same version is no longer triggered.</p> <p>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. (<code>[#391](twisted/towncrier#391) <https://github.com/hawkowl/towncrier/issues/391></code>_)</p> </li> </ul> <h2>Improved Documentation</h2> <ul> <li>Improve <code>CONTRIBUTING.rst</code> and add PR template. (<code>[#342](twisted/towncrier#342) <https://github.com/hawkowl/towncrier/issues/342></code>_)</li> <li>Move docs too the main branch and document custom fragment types. (<code>[#367](twisted/towncrier#367) <https://github.com/hawkowl/towncrier/issues/367></code>_)</li> <li>The CLI help messages were updated to contain more information. (<code>[#384](twisted/towncrier#384) <https://github.com/hawkowl/towncrier/issues/384></code>_)</li> </ul> <h2>Deprecations and Removals</h2> <ul> <li>Support for all Python versions older than 3.7 has been dropped. (<code>[#378](twisted/towncrier#378) <https://github.com/hawkowl/towncrier/issues/378></code>_)</li> </ul> <h2>Misc</h2> <ul> <li><code>[#292](twisted/towncrier#292) <https://github.com/hawkowl/towncrier/issues/292></code><em>, <code>[#330](twisted/towncrier#330) <https://github.com/hawkowl/towncrier/issues/330></code></em>, <code>[#366](twisted/towncrier#366) <https://github.com/hawkowl/towncrier/issues/366></code><em>, <code>[#376](twisted/towncrier#376) <https://github.com/hawkowl/towncrier/issues/376></code></em>, <code>[#377](twisted/towncrier#377) <https://github.com/hawkowl/towncrier/issues/377></code><em>, <code>[#380](twisted/towncrier#380) <https://github.com/hawkowl/towncrier/issues/380></code></em>, <code>[#381](twisted/towncrier#381) <https://github.com/hawkowl/towncrier/issues/381></code><em>, <code>[#382](twisted/towncrier#382) <https://github.com/hawkowl/towncrier/issues/382></code></em>, <code>[#383](twisted/towncrier#383) <https://github.com/hawkowl/towncrier/issues/383></code><em>, <code>[#393](twisted/towncrier#393) <https://github.com/hawkowl/towncrier/issues/393></code></em>, <code>[#399](twisted/towncrier#399) <https://github.com/hawkowl/towncrier/issues/399></code><em>, <code>[#402](twisted/towncrier#402) <https://github.com/hawkowl/towncrier/issues/402></code></em></li> </ul> <!-- raw HTML omitted --> </blockquote> <p>... (truncated)</p> </details> <details> <summary>Commits</summary> <ul> <li><a href="https://github.com/twisted/towncrier/commit/411f2676b18daf9ba1eb656f7dc6c726397c4a9e"><code>411f267</code></a> Update version for final release.</li> <li><a href="https://github.com/twisted/towncrier/commit/f031dfa94e52e07b6c71e88cd5cd50e3803ad96c"><code>f031dfa</code></a> towncrier build --yes</li> <li><a href="https://github.com/twisted/towncrier/commit/4c854f58a2074458cd66767aca9f3aaa34d842d8"><code>4c854f5</code></a> Merge pull request <a href="https://github-redirect.dependabot.com/hawkowl/towncrier/issues/402">#402</a> from webknjaz/patch-2</li> <li><a href="https://github.com/twisted/towncrier/commit/f911402b69960bee358b0c2011d685721afa9454"><code>f911402</code></a> Pin external github actions,</li> <li><a href="https://github.com/twisted/towncrier/commit/a814202234214182855fe4a5ffb40c7f7aec2b04"><code>a814202</code></a> [pre-commit.ci] auto fixes from pre-commit.com hooks</li> <li><a href="https://github.com/twisted/towncrier/commit/675219a6deac7c65bb94b72da55059b7077e5ec4"><code>675219a</code></a> Add a dummy change note for PR <a href="https://github-redirect.dependabot.com/hawkowl/towncrier/issues/402">#402</a></li> <li><a href="https://github.com/twisted/towncrier/commit/b566bfb0dcdcd86fa9d349875eba15e647c06459"><code>b566bfb</code></a> Uninvent the wheel w/ <code>re-actors/alls-green</code> @ GHA</li> <li><a href="https://github.com/twisted/towncrier/commit/5bf0a4653bb2adf52162550d436f1dc39f6e0446"><code>5bf0a46</code></a> Merge pull request <a href="https://github-redirect.dependabot.com/hawkowl/towncrier/issues/396">#396</a> from twisted/292-more-ci-checks</li> <li><a href="https://github.com/twisted/towncrier/commit/1bb62219a9e7b0d969292cae56104678b8bea151"><code>1bb6221</code></a> Merge branch 'trunk' into 292-more-ci-checks</li> <li><a href="https://github.com/twisted/towncrier/commit/07baa2ba4b1159462dcb212395be1de91674698d"><code>07baa2b</code></a> Merge pull request <a href="https://github-redirect.dependabot.com/hawkowl/towncrier/issues/395">#395</a> from twisted/384-cli-help</li> <li>Additional commits viewable in <a href="https://github.com/hawkowl/towncrier/compare/21.9.0...22.8.0">compare view</a></li> </ul> </details> <br /> 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` 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> Changes needed for this * Invert logic for single file. 22.8.0 fixed the logic such that single_file=False is correct when you have more than one file * Pin versions of towncrier and sphinx towncrier to reflect this (so we get the right config) Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Jens H. Nielsen <Jens.Nielsen@microsoft.com>
acabarbaye
added a commit
to ARMmbed/continuous-delivery-scripts
that referenced
this pull request
Nov 30, 2022
Bumps [towncrier](https://github.com/hawkowl/towncrier) from 21.9.0 to 22.8.0. <details> <summary>Release notes</summary> <p><em>Sourced from <a href="https://github.com/hawkowl/towncrier/releases">towncrier's releases</a>.</em></p> <blockquote> <h2>Towncrier 22.8.0</h2> <h1>towncrier 22.8.0 (2022-08-29)</h1> <p>No significant changes since the previous release candidate.</p> <h1>towncrier 22.8.0.rc1 (2022-08-28)</h1> <h2>Features</h2> <ul> <li> <p>Make the check subcommand succeed for branches that change the news file</p> <p>This should enable the <code>check</code> 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). (<code>[#337](twisted/towncrier#337) <https://github.com/hawkowl/towncrier/issues/337></code>_)</p> </li> <li> <p>Added support to tables in toml settings, which provides a more intuitive way to configure custom types. (<code>[#369](twisted/towncrier#369) <https://github.com/hawkowl/towncrier/issues/369></code>_)</p> </li> <li> <p>The <code>towncrier create</code> command line now has a new <code>-m TEXT</code> argument that is used to define the content of the newly created fragment. (<code>[#374](twisted/towncrier#374) <https://github.com/hawkowl/towncrier/issues/374></code>_)</p> </li> </ul> <h2>Bugfixes</h2> <ul> <li> <p>The extra newline between the title and rendered content when using <code>--draft</code> is no longer inserted. (<code>[#105](twisted/towncrier#105) <https://github.com/hawkowl/towncrier/issues/105></code>_)</p> </li> <li> <p>The detection of duplicate release notes was fixed and recording changes of same version is no longer triggered.</p> <p>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. (<code>[#391](twisted/towncrier#391) <https://github.com/hawkowl/towncrier/issues/391></code>_)</p> </li> </ul> <h2>Improved Documentation</h2> <ul> <li>Improve <code>CONTRIBUTING.rst</code> and add PR template. (<code>[#342](twisted/towncrier#342) <https://github.com/hawkowl/towncrier/issues/342></code>_)</li> <li>Move docs too the main branch and document custom fragment types. (<code>[#367](twisted/towncrier#367) <https://github.com/hawkowl/towncrier/issues/367></code>_)</li> <li>The CLI help messages were updated to contain more information. (<code>[#384](twisted/towncrier#384) <https://github.com/hawkowl/towncrier/issues/384></code>_)</li> </ul> <h2>Deprecations and Removals</h2> <ul> <li>Support for all Python versions older than 3.7 has been dropped. (<code>[#378](twisted/towncrier#378) <https://github.com/hawkowl/towncrier/issues/378></code>_)</li> </ul> <h2>Towncrier 22.8.0rc1</h2> <h1>towncrier 22.8.0.rc1 (2022-08-28)</h1> <p>Features</p> <!-- 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 22.8.0 (2022-08-29)</h1> <p>No significant changes since the previous release candidate.</p> <h1>towncrier 22.8.0.rc1 (2022-08-28)</h1> <h2>Features</h2> <ul> <li> <p>Make the check subcommand succeed for branches that change the news file</p> <p>This should enable the <code>check</code> 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). (<code>[#337](twisted/towncrier#337) <https://github.com/hawkowl/towncrier/issues/337></code>_)</p> </li> <li> <p>Added support to tables in toml settings, which provides a more intuitive way to configure custom types. (<code>[#369](twisted/towncrier#369) <https://github.com/hawkowl/towncrier/issues/369></code>_)</p> </li> <li> <p>The <code>towncrier create</code> command line now has a new <code>-m TEXT</code> argument that is used to define the content of the newly created fragment. (<code>[#374](twisted/towncrier#374) <https://github.com/hawkowl/towncrier/issues/374></code>_)</p> </li> </ul> <h2>Bugfixes</h2> <ul> <li> <p>The extra newline between the title and rendered content when using <code>--draft</code> is no longer inserted. (<code>[#105](twisted/towncrier#105) <https://github.com/hawkowl/towncrier/issues/105></code>_)</p> </li> <li> <p>The detection of duplicate release notes was fixed and recording changes of same version is no longer triggered.</p> <p>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. (<code>[#391](twisted/towncrier#391) <https://github.com/hawkowl/towncrier/issues/391></code>_)</p> </li> </ul> <h2>Improved Documentation</h2> <ul> <li>Improve <code>CONTRIBUTING.rst</code> and add PR template. (<code>[#342](twisted/towncrier#342) <https://github.com/hawkowl/towncrier/issues/342></code>_)</li> <li>Move docs too the main branch and document custom fragment types. (<code>[#367](twisted/towncrier#367) <https://github.com/hawkowl/towncrier/issues/367></code>_)</li> <li>The CLI help messages were updated to contain more information. (<code>[#384](twisted/towncrier#384) <https://github.com/hawkowl/towncrier/issues/384></code>_)</li> </ul> <h2>Deprecations and Removals</h2> <ul> <li>Support for all Python versions older than 3.7 has been dropped. (<code>[#378](twisted/towncrier#378) <https://github.com/hawkowl/towncrier/issues/378></code>_)</li> </ul> <h2>Misc</h2> <ul> <li><code>[#292](twisted/towncrier#292) <https://github.com/hawkowl/towncrier/issues/292></code><em>, <code>[#330](twisted/towncrier#330) <https://github.com/hawkowl/towncrier/issues/330></code></em>, <code>[#366](twisted/towncrier#366) <https://github.com/hawkowl/towncrier/issues/366></code><em>, <code>[#376](twisted/towncrier#376) <https://github.com/hawkowl/towncrier/issues/376></code></em>, <code>[#377](twisted/towncrier#377) <https://github.com/hawkowl/towncrier/issues/377></code><em>, <code>[#380](twisted/towncrier#380) <https://github.com/hawkowl/towncrier/issues/380></code></em>, <code>[#381](twisted/towncrier#381) <https://github.com/hawkowl/towncrier/issues/381></code><em>, <code>[#382](twisted/towncrier#382) <https://github.com/hawkowl/towncrier/issues/382></code></em>, <code>[#383](twisted/towncrier#383) <https://github.com/hawkowl/towncrier/issues/383></code><em>, <code>[#393](twisted/towncrier#393) <https://github.com/hawkowl/towncrier/issues/393></code></em>, <code>[#399](twisted/towncrier#399) <https://github.com/hawkowl/towncrier/issues/399></code><em>, <code>[#402](twisted/towncrier#402) <https://github.com/hawkowl/towncrier/issues/402></code></em></li> </ul> </blockquote> </details> <details> <summary>Commits</summary> <ul> <li><a href="https://github.com/twisted/towncrier/commit/411f2676b18daf9ba1eb656f7dc6c726397c4a9e"><code>411f267</code></a> Update version for final release.</li> <li><a href="https://github.com/twisted/towncrier/commit/f031dfa94e52e07b6c71e88cd5cd50e3803ad96c"><code>f031dfa</code></a> towncrier build --yes</li> <li><a href="https://github.com/twisted/towncrier/commit/4c854f58a2074458cd66767aca9f3aaa34d842d8"><code>4c854f5</code></a> Merge pull request <a href="https://github-redirect.dependabot.com/hawkowl/towncrier/issues/402">#402</a> from webknjaz/patch-2</li> <li><a href="https://github.com/twisted/towncrier/commit/f911402b69960bee358b0c2011d685721afa9454"><code>f911402</code></a> Pin external github actions,</li> <li><a href="https://github.com/twisted/towncrier/commit/a814202234214182855fe4a5ffb40c7f7aec2b04"><code>a814202</code></a> [pre-commit.ci] auto fixes from pre-commit.com hooks</li> <li><a href="https://github.com/twisted/towncrier/commit/675219a6deac7c65bb94b72da55059b7077e5ec4"><code>675219a</code></a> Add a dummy change note for PR <a href="https://github-redirect.dependabot.com/hawkowl/towncrier/issues/402">#402</a></li> <li><a href="https://github.com/twisted/towncrier/commit/b566bfb0dcdcd86fa9d349875eba15e647c06459"><code>b566bfb</code></a> Uninvent the wheel w/ <code>re-actors/alls-green</code> @ GHA</li> <li><a href="https://github.com/twisted/towncrier/commit/5bf0a4653bb2adf52162550d436f1dc39f6e0446"><code>5bf0a46</code></a> Merge pull request <a href="https://github-redirect.dependabot.com/hawkowl/towncrier/issues/396">#396</a> from twisted/292-more-ci-checks</li> <li><a href="https://github.com/twisted/towncrier/commit/1bb62219a9e7b0d969292cae56104678b8bea151"><code>1bb6221</code></a> Merge branch 'trunk' into 292-more-ci-checks</li> <li><a href="https://github.com/twisted/towncrier/commit/07baa2ba4b1159462dcb212395be1de91674698d"><code>07baa2b</code></a> Merge pull request <a href="https://github-redirect.dependabot.com/hawkowl/towncrier/issues/395">#395</a> from twisted/384-cli-help</li> <li>Additional commits viewable in <a href="https://github.com/hawkowl/towncrier/compare/21.9.0...22.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 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] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Monty Bot <monty-bot@arm.com> Co-authored-by: Adrien CABARBAYE <adrien.cabarbaye@arm.com>
wip-sync
referenced
this pull request
in NetBSD/pkgsrc-wip
May 5, 2023
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>`_)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
the version-already-produced error raising cannot be reached in expected single file mode like the test case in :test_write:WritingTests.test_append_at_top_with_hint