Bootstrap pre-commit.ci #381

hynek · 2022-04-11T05:18:37Z

In an absolutely perfect demonstration, the applied missing test in #380 broke pyupgrade. This PR will prevent this happening in the future. :)

This adds no new code linters or formatters, but ensures that flake8 (and some
minor others) are run using pre-commit.ci on each PR.

That's very fast and fixes problems in-PR, not requiring review turnarounds.

Additionally we get more stable linters via version pinning for free. The
updates are capped to once per month to prevent unnecessary churn.

Since flake8 now runs over the whole code base, I've added a few noqas where it
made sense.

This adds no new code linters or formatters, but ensures that flake8 (and some minor others) are run using pre-commit.ci on each PR. That's very fast and fixes problems in-PR, not requiring review turnarounds. Additionally we get more stable linters via version pinning for free. The updates are capped to once per month to prevent unnecessary churn. Since flake8 now runs over the whole code base, I've added a few noqas where it made sense.

codecov · 2022-04-11T05:28:38Z

Codecov Report

Merging #381 (aff21dd) into master (2e2208d) will not change coverage.
The diff coverage is 100.00%.

❗ Current head aff21dd differs from pull request most recent head d849925. Consider uploading reports for the commit d849925 to get more accurate results

@@           Coverage Diff           @@
##           master     #381   +/-   ##
=======================================
  Coverage   97.60%   97.60%           
=======================================
  Files          22       22           
  Lines        1334     1334           
  Branches      253      253           
=======================================
  Hits         1302     1302           
  Misses         16       16           
  Partials       16       16

Impacted Files	Coverage Δ
src/towncrier/test/test_build.py	`100.00% <100.00%> (ø)`

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 2e2208d...d849925. Read the comment docs.

hynek · 2022-04-11T05:47:41Z

Hmmm it looks like I might not be authorized to add pre-commit to this repo. 🤔

hynek · 2022-04-11T07:11:56Z

Turns out I was spamming @glyph, but it's live now!

See https://results.pre-commit.ci/run/github/48647797/1649661064.5Ui8YSZ6SNekzeJLUWgBbA and the wonderful total time to completion: 6.1s

adiroiban · 2022-04-11T10:13:55Z

force the merge... codecov.io just being codecov.io and not reporting a status :)

Thanks for the PR.

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>  </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>

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>  </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 /> [![Dependabot compatibility score](https://dependabot-badges.githubapp.com/badges/compatibility_score?dependency-name=towncrier&package-manager=pip&previous-version=21.9.0&new-version=22.8.0)](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>

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 added 2 commits April 11, 2022 07:52

Add newsfragment

baba219

Remove stray exclude

aff21dd

hynek marked this pull request as draft April 11, 2022 06:49

trigger ci

d849925

hynek marked this pull request as ready for review April 11, 2022 07:12

adiroiban merged commit 3b52db7 into twisted:master Apr 11, 2022

hynek deleted the pre-commit_ci branch April 11, 2022 10:33

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Bootstrap pre-commit.ci #381

Bootstrap pre-commit.ci #381

hynek commented Apr 11, 2022

codecov bot commented Apr 11, 2022 •

edited

Loading

hynek commented Apr 11, 2022

hynek commented Apr 11, 2022

adiroiban commented Apr 11, 2022 •

edited

Loading

Bootstrap pre-commit.ci #381

Bootstrap pre-commit.ci #381

Conversation

hynek commented Apr 11, 2022

codecov bot commented Apr 11, 2022 • edited Loading

Codecov Report

hynek commented Apr 11, 2022

hynek commented Apr 11, 2022

adiroiban commented Apr 11, 2022 • edited Loading

codecov bot commented Apr 11, 2022 •

edited

Loading

adiroiban commented Apr 11, 2022 •

edited

Loading