Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Add a pre-commit hooks #498

Closed
COUR4G3 opened this issue Apr 20, 2023 · 1 comment
Closed

Add a pre-commit hooks #498

COUR4G3 opened this issue Apr 20, 2023 · 1 comment

Comments

@COUR4G3
Copy link
Contributor

COUR4G3 commented Apr 20, 2023

I've been toying around with the idea of creating Towncrier pre-commit hooks, one most importantly just checking that the news fragments are valid and then maybe also one to actually build the news from fragments if they hadn't already been applied.

So we'd just need to create a .pre-commit-hooks.yaml and set up with the appropriate defaults. I'm going to go ahead and create a PR, but I thought an issue might be a better place to discuss any objections or ideas.

Thinking of a .pre-commit-hooks.yaml like:

- id: towncrier-check
  name: towncrier-check
  description: Check Towncrier news updates
  entry: towncrier --draft
  pass_filenames: false
  types: [text]
  files: newsfragments/
  language: python
- id: towncrier-update
  name: towncrier-update
  description: Update news with Towncrier
  entry: towncrier
  pass_filenames: false
  args: ["--yes"]
  files: newsfragments/
  language: python

And then in one of my project's cases were a use a different towncrier configuration, I'd implement my .pre-commit-config.yaml like:

repos:
  - repo: https://github.com/twisted/towncrier
    rev: trunk
    hooks:
      - id: towncrier-check
        files: $changelog\.d/

Thoughts and suggestions welcome 😄
COUR4G3 added a commit to COUR4G3/towncrier that referenced this issue Apr 20, 2023
@COUR4G3
Added pre-commit hooks for checking and updating news in projects usi…
379349d 
…ng pre-commit (twisted#498)

* added ``towncrier-check`` to just check newly commited news fragments
* added ``towncrier-update`` to actually update the news
COUR4G3 added a commit to COUR4G3/towncrier that referenced this issue Apr 20, 2023
@COUR4G3
Added pre-commit hooks for checking and updating news in projects usi…
14adb5f 
…ng pre-commit (twisted#498)

* added ``towncrier-check`` to just check newly commited news fragments
* added ``towncrier-update`` to actually update the news
* added documentation section for ``pre-commit``
@COUR4G3 COUR4G3 mentioned this issue Apr 20, 2023
Merged
7 tasks
COUR4G3 added a commit to COUR4G3/towncrier that referenced this issue Apr 27, 2023
@COUR4G3
Added pre-commit hooks for checking and updating news in projects usi…
b5fe641 
…ng pre-commit (twisted#498)

* added ``towncrier-check`` to just check newly commited news fragments
* added ``towncrier-update`` to actually update the news
* added documentation section for ``pre-commit``
hynek added a commit that referenced this issue Apr 27, 2023
@COUR4G3 @pre-commit-ci @hynek
Added pre-commit hooks (#498) (#499)
a351582 
* Added pre-commit hooks for checking and updating news in projects using pre-commit (#498)

* added ``towncrier-check`` to just check newly commited news fragments
* added ``towncrier-update`` to actually update the news
* added documentation section for ``pre-commit``

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Apply suggestions from code review

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Hynek Schlawack <[email protected]>
@COUR4G3
Copy link
Contributor Author

COUR4G3 commented Apr 28, 2023

And done in #499

@COUR4G3 COUR4G3 closed this as completed Apr 28, 2023
Dreamsorcerer added a commit to aio-libs/aiohttp that referenced this issue Jul 28, 2023
@dependabot @Dreamsorcerer
Bump towncrier from 22.8.0 to 23.6.0 (#7411)
0a09738 
Bumps [towncrier](https://github.com/twisted/towncrier) from 22.8.0 to
23.6.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 23.6.0</h2>
<h1>towncrier 23.6.0 (2023-06-06)</h1>
<p>This is the last release to support Python 3.7.</p>
<h2>Features</h2>
<ul>
<li>
<p>Make <code>towncrier create</code> use the fragment counter rather
than failing on existing fragment names.</p>
<p>For example, if there is an existing fragment named
<code>123.feature</code>, then <code>towncrier create 123.feature</code>
will now create a fragment named <code>123.feature.1</code>. (<a
href="https://redirect.github.com/twisted/towncrier/issues/475">#475</a>)</p>
</li>
<li>
<p>Provide a default Markdown template if the configured filename ends
with <code>.md</code>.</p>
<p>The Markdown template uses the same rendered format as the default
<em>reStructuredText</em> template, but with a Markdown syntax. (<a
href="https://redirect.github.com/twisted/towncrier/issues/483">#483</a>)</p>
</li>
<li>
<p>Towncrier no longer depends on setuptools &amp; uses
importlib.resources (or its backport) instead. (<a
href="https://redirect.github.com/twisted/towncrier/issues/496">#496</a>)</p>
</li>
<li>
<p>Added pre-commit hooks for checking and updating news in projects
using pre-commit. (<a
href="https://redirect.github.com/twisted/towncrier/issues/498">#498</a>)</p>
</li>
<li>
<p>Calling <code>towncrier check</code> without an existing
configuration, will just show only an error message.</p>
<p>In previous versions, a traceback was generated instead of the error
message. (<a
href="https://redirect.github.com/twisted/towncrier/issues/501">#501</a>)</p>
</li>
</ul>
<h2>Bugfixes</h2>
<ul>
<li>
<p>Fix creating fragment in a section not adding random characters.</p>
<p>For example, <code>towncrier create some_section/+.feature</code>
should end up as a fragment named something like
<code>news/some_section/+a4e22da1.feature</code>. (<a
href="https://redirect.github.com/twisted/towncrier/issues/468">#468</a>)</p>
</li>
<li>
<p>Fix the ReadTheDocs build for <code>towncrier</code> which was broken
due to the python version in use being 3.8. Upgrade to 3.11. (<a
href="https://redirect.github.com/twisted/towncrier/issues/509">#509</a>)</p>
</li>
</ul>
<h2>Improved Documentation</h2>
<ul>
<li>Moved man page to correct section (<a
href="https://redirect.github.com/twisted/towncrier/issues/470">#470</a>)</li>
<li>Update link to Quick Start in configuration.html to point to
Tutorial instead. (<a
href="https://redirect.github.com/twisted/towncrier/issues/504">#504</a>)</li>
<li>Add a note about the build command's <code>--version</code>
requiring the command to be explicitly passed. (<a
href="https://redirect.github.com/twisted/towncrier/issues/511">#511</a>)</li>
<li>Fix typos in the Pre-Commit docs. (<a
href="https://redirect.github.com/twisted/towncrier/issues/512">#512</a>)</li>
</ul>
<h2>Misc</h2>
<ul>
<li><a
href="https://redirect.github.com/twisted/towncrier/issues/459">#459</a>,
<a
href="https://redirect.github.com/twisted/towncrier/issues/462">#462</a>,
<a
href="https://redirect.github.com/twisted/towncrier/issues/472">#472</a>,
<a
href="https://redirect.github.com/twisted/towncrier/issues/485">#485</a>,
<a
href="https://redirect.github.com/twisted/towncrier/issues/486">#486</a>,
<a
href="https://redirect.github.com/twisted/towncrier/issues/487">#487</a>,
<a
href="https://redirect.github.com/twisted/towncrier/issues/488">#488</a>,
<a
href="https://redirect.github.com/twisted/towncrier/issues/495">#495</a>,
<a
href="https://redirect.github.com/twisted/towncrier/issues/497">#497</a>,
<a
href="https://redirect.github.com/twisted/towncrier/issues/507">#507</a>,
<a
href="https://redirect.github.com/twisted/towncrier/issues/1117">#1117</a>,
<a
href="https://redirect.github.com/twisted/towncrier/issues/513">#513</a></li>
</ul>
<h2>Towncrier 23.6.0rc1</h2>
<h1>towncrier 23.6.0rc1 (2023-06-05)</h1>
<p>This is the last release to support Python 3.7.</p>
<h2>Features</h2>
<ul>
<li>Make <code>towncrier create</code> use the fragment counter rather
than failing on existing fragment names.</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 23.6.0 (2023-06-06)</h1>
<p>This is the last release to support Python 3.7.</p>
<h2>Features</h2>
<ul>
<li>
<p>Make <code>towncrier create</code> use the fragment counter rather
than failing
on existing fragment names.</p>
<p>For example, if there is an existing fragment named
<code>123.feature</code>,
then <code>towncrier create 123.feature</code> will now create a
fragment
named <code>123.feature.1</code>.
(<code>[#475](twisted/towncrier#475)
&lt;https://github.com/twisted/towncrier/issues/475&gt;</code>_)</p>
</li>
<li>
<p>Provide a default Markdown template if the configured filename ends
with <code>.md</code>.</p>
<p>The Markdown template uses the same rendered format as the default
<em>reStructuredText</em> template, but with a Markdown syntax.
(<code>[#483](twisted/towncrier#483)
&lt;https://github.com/twisted/towncrier/issues/483&gt;</code>_)</p>
</li>
<li>
<p>Towncrier no longer depends on setuptools &amp; uses
importlib.resources (or its backport) instead.
(<code>[#496](twisted/towncrier#496)
&lt;https://github.com/twisted/towncrier/issues/496&gt;</code>_)</p>
</li>
<li>
<p>Added pre-commit hooks for checking and updating news in projects
using pre-commit.
(<code>[#498](twisted/towncrier#498)
&lt;https://github.com/twisted/towncrier/issues/498&gt;</code>_)</p>
</li>
<li>
<p>Calling <code>towncrier check</code> without an existing
configuration, will just show only an error message.</p>
<p>In previous versions, a traceback was generated instead of the error
message. (<code>[#501](twisted/towncrier#501)
&lt;https://github.com/twisted/towncrier/issues/501&gt;</code>_)</p>
</li>
</ul>
<h2>Bugfixes</h2>
<ul>
<li>
<p>Fix creating fragment in a section not adding random characters.</p>
<p>For example, <code>towncrier create some_section/+.feature</code>
should end up as a fragment named something like
<code>news/some_section/+a4e22da1.feature</code>.
(<code>[#468](twisted/towncrier#468)
&lt;https://github.com/twisted/towncrier/issues/468&gt;</code>_)</p>
</li>
<li>
<p>Fix the ReadTheDocs build for <code>towncrier</code> which was broken
due to the python version in use being 3.8. Upgrade to 3.11.
(<code>[#509](twisted/towncrier#509)
&lt;https://github.com/twisted/towncrier/issues/509&gt;</code>_)</p>
</li>
</ul>
<h2>Improved Documentation</h2>
<ul>
<li>Moved man page to correct section
(<code>[#470](twisted/towncrier#470)
&lt;https://github.com/twisted/towncrier/issues/470&gt;</code>_)</li>
<li>Update link to Quick Start in configuration.html to point to
Tutorial instead.
(<code>[#504](twisted/towncrier#504)
&lt;https://github.com/twisted/towncrier/issues/504&gt;</code>_)</li>
<li>Add a note about the build command's <code>--version</code>
requiring the command to be explicitly passed.
(<code>[#511](twisted/towncrier#511)
&lt;https://github.com/twisted/towncrier/issues/511&gt;</code>_)</li>
<li>Fix typos in the Pre-Commit docs.
(<code>[#512](twisted/towncrier#512)
&lt;https://github.com/twisted/towncrier/issues/512&gt;</code>_)</li>
</ul>
<h2>Misc</h2>
<ul>
<li><code>[#459](twisted/towncrier#459)
&lt;https://github.com/twisted/towncrier/issues/459&gt;</code><em>,
<code>[#462](twisted/towncrier#462)
&lt;https://github.com/twisted/towncrier/issues/462&gt;</code></em>,
<code>[#472](twisted/towncrier#472)
&lt;https://github.com/twisted/towncrier/issues/472&gt;</code><em>,
<code>[#485](twisted/towncrier#485)
&lt;https://github.com/twisted/towncrier/issues/485&gt;</code></em>,
<code>[#486](twisted/towncrier#486)
&lt;https://github.com/twisted/towncrier/issues/486&gt;</code><em>,
<code>[#487](twisted/towncrier#487)
&lt;https://github.com/twisted/towncrier/issues/487&gt;</code></em>,
<code>[#488](twisted/towncrier#488)
&lt;https://github.com/twisted/towncrier/issues/488&gt;</code><em>,
<code>[#495](twisted/towncrier#495)
&lt;https://github.com/twisted/towncrier/issues/495&gt;</code></em>,
<code>[#497](twisted/towncrier#497)
&lt;https://github.com/twisted/towncrier/issues/497&gt;</code><em>,
<code>[#507](twisted/towncrier#507)
&lt;https://github.com/twisted/towncrier/issues/507&gt;</code></em>,
<code>[#1117](https://github.com/twisted/towncrier/issues/1117)
&lt;https://github.com/twisted/towncrier/issues/1117&gt;</code><em>,
<code>[#513](twisted/towncrier#513)
&lt;https://github.com/twisted/towncrier/issues/513&gt;</code></em></li>
</ul>
<p>towncrier 22.12.0 (2022-12-21)</p>
<!-- raw HTML omitted -->
</blockquote>
<p>... (truncated)</p>
</details>
<details>
<summary>Commits</summary>
<ul>
<li><a
href="https://github.com/twisted/towncrier/commit/22a5b015e6404900bfaed4d218cacbd09fc43916"><code>22a5b01</code></a>
Update for final release.</li>
<li><a
href="https://github.com/twisted/towncrier/commit/0d9f08708a29a65050c907995e05180d5320fa6f"><code>0d9f087</code></a>
Fix news file.</li>
<li><a
href="https://github.com/twisted/towncrier/commit/32d7034b82bef8b9f36b6aaec2e9c0de328de222"><code>32d7034</code></a>
Remove deploy env requirement.</li>
<li><a
href="https://github.com/twisted/towncrier/commit/13e6d0c52e5dd63bf6fbf5434731dc4997ecfc82"><code>13e6d0c</code></a>
Conditionally run the whole publish.</li>
<li><a
href="https://github.com/twisted/towncrier/commit/6b9b85a252cc10a40d024710777df48b53740b9a"><code>6b9b85a</code></a>
Add dedicated environment.</li>
<li><a
href="https://github.com/twisted/towncrier/commit/3deaebd35a38bf89e1e0d92bf7822b3ffa61bda0"><code>3deaebd</code></a>
Add a top title to the release notes.</li>
<li><a
href="https://github.com/twisted/towncrier/commit/a94f23c5e3e410bffd44cefbd961192d28fe76f1"><code>a94f23c</code></a>
Fix NEWS.rst formatting.</li>
<li><a
href="https://github.com/twisted/towncrier/commit/3ba6cd1a1830d53266129770556c3d3ea593fcd6"><code>3ba6cd1</code></a>
Include the release notes in the docs to make it easyier to review the
RST fo...</li>
<li><a
href="https://github.com/twisted/towncrier/commit/1888debeb12afef9406ac997ad1f9e554423832c"><code>1888deb</code></a>
Add info about 3.7.</li>
<li><a
href="https://github.com/twisted/towncrier/commit/b7a561cf5a85fce14e4abc1ea17d8d9ee59d2e60"><code>b7a561c</code></a>
Update for release candidate.</li>
<li>Additional commits viewable in <a
href="https://github.com/twisted/towncrier/compare/22.8.0...23.6.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=22.8.0&new-version=23.6.0)](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 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>
Co-authored-by: dependabot[bot] <dependabot[bot]@users.noreply.github.com>
Co-authored-by: Sam Bull <[email protected]>
github-actions bot pushed a commit to aio-libs/aiohttp that referenced this issue Jul 29, 2023
@dependabot @Dreamsorcerer
Bump towncrier from 22.8.0 to 23.6.0 (#7425)
9c96208 
Bumps [towncrier](https://github.com/twisted/towncrier) from 22.8.0 to
23.6.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 23.6.0</h2>
<h1>towncrier 23.6.0 (2023-06-06)</h1>
<p>This is the last release to support Python 3.7.</p>
<h2>Features</h2>
<ul>
<li>
<p>Make <code>towncrier create</code> use the fragment counter rather
than failing on existing fragment names.</p>
<p>For example, if there is an existing fragment named
<code>123.feature</code>, then <code>towncrier create 123.feature</code>
will now create a fragment named <code>123.feature.1</code>. (<a
href="https://redirect.github.com/twisted/towncrier/issues/475">#475</a>)</p>
</li>
<li>
<p>Provide a default Markdown template if the configured filename ends
with <code>.md</code>.</p>
<p>The Markdown template uses the same rendered format as the default
<em>reStructuredText</em> template, but with a Markdown syntax. (<a
href="https://redirect.github.com/twisted/towncrier/issues/483">#483</a>)</p>
</li>
<li>
<p>Towncrier no longer depends on setuptools &amp; uses
importlib.resources (or its backport) instead. (<a
href="https://redirect.github.com/twisted/towncrier/issues/496">#496</a>)</p>
</li>
<li>
<p>Added pre-commit hooks for checking and updating news in projects
using pre-commit. (<a
href="https://redirect.github.com/twisted/towncrier/issues/498">#498</a>)</p>
</li>
<li>
<p>Calling <code>towncrier check</code> without an existing
configuration, will just show only an error message.</p>
<p>In previous versions, a traceback was generated instead of the error
message. (<a
href="https://redirect.github.com/twisted/towncrier/issues/501">#501</a>)</p>
</li>
</ul>
<h2>Bugfixes</h2>
<ul>
<li>
<p>Fix creating fragment in a section not adding random characters.</p>
<p>For example, <code>towncrier create some_section/+.feature</code>
should end up as a fragment named something like
<code>news/some_section/+a4e22da1.feature</code>. (<a
href="https://redirect.github.com/twisted/towncrier/issues/468">#468</a>)</p>
</li>
<li>
<p>Fix the ReadTheDocs build for <code>towncrier</code> which was broken
due to the python version in use being 3.8. Upgrade to 3.11. (<a
href="https://redirect.github.com/twisted/towncrier/issues/509">#509</a>)</p>
</li>
</ul>
<h2>Improved Documentation</h2>
<ul>
<li>Moved man page to correct section (<a
href="https://redirect.github.com/twisted/towncrier/issues/470">#470</a>)</li>
<li>Update link to Quick Start in configuration.html to point to
Tutorial instead. (<a
href="https://redirect.github.com/twisted/towncrier/issues/504">#504</a>)</li>
<li>Add a note about the build command's <code>--version</code>
requiring the command to be explicitly passed. (<a
href="https://redirect.github.com/twisted/towncrier/issues/511">#511</a>)</li>
<li>Fix typos in the Pre-Commit docs. (<a
href="https://redirect.github.com/twisted/towncrier/issues/512">#512</a>)</li>
</ul>
<h2>Misc</h2>
<ul>
<li><a
href="https://redirect.github.com/twisted/towncrier/issues/459">#459</a>,
<a
href="https://redirect.github.com/twisted/towncrier/issues/462">#462</a>,
<a
href="https://redirect.github.com/twisted/towncrier/issues/472">#472</a>,
<a
href="https://redirect.github.com/twisted/towncrier/issues/485">#485</a>,
<a
href="https://redirect.github.com/twisted/towncrier/issues/486">#486</a>,
<a
href="https://redirect.github.com/twisted/towncrier/issues/487">#487</a>,
<a
href="https://redirect.github.com/twisted/towncrier/issues/488">#488</a>,
<a
href="https://redirect.github.com/twisted/towncrier/issues/495">#495</a>,
<a
href="https://redirect.github.com/twisted/towncrier/issues/497">#497</a>,
<a
href="https://redirect.github.com/twisted/towncrier/issues/507">#507</a>,
<a
href="https://redirect.github.com/twisted/towncrier/issues/1117">#1117</a>,
<a
href="https://redirect.github.com/twisted/towncrier/issues/513">#513</a></li>
</ul>
<h2>Towncrier 23.6.0rc1</h2>
<h1>towncrier 23.6.0rc1 (2023-06-05)</h1>
<p>This is the last release to support Python 3.7.</p>
<h2>Features</h2>
<ul>
<li>Make <code>towncrier create</code> use the fragment counter rather
than failing on existing fragment names.</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 23.6.0 (2023-06-06)</h1>
<p>This is the last release to support Python 3.7.</p>
<h2>Features</h2>
<ul>
<li>
<p>Make <code>towncrier create</code> use the fragment counter rather
than failing
on existing fragment names.</p>
<p>For example, if there is an existing fragment named
<code>123.feature</code>,
then <code>towncrier create 123.feature</code> will now create a
fragment
named <code>123.feature.1</code>.
(<code>[#475](twisted/towncrier#475)
&lt;https://github.com/twisted/towncrier/issues/475&gt;</code>_)</p>
</li>
<li>
<p>Provide a default Markdown template if the configured filename ends
with <code>.md</code>.</p>
<p>The Markdown template uses the same rendered format as the default
<em>reStructuredText</em> template, but with a Markdown syntax.
(<code>[#483](twisted/towncrier#483)
&lt;https://github.com/twisted/towncrier/issues/483&gt;</code>_)</p>
</li>
<li>
<p>Towncrier no longer depends on setuptools &amp; uses
importlib.resources (or its backport) instead.
(<code>[#496](twisted/towncrier#496)
&lt;https://github.com/twisted/towncrier/issues/496&gt;</code>_)</p>
</li>
<li>
<p>Added pre-commit hooks for checking and updating news in projects
using pre-commit.
(<code>[#498](twisted/towncrier#498)
&lt;https://github.com/twisted/towncrier/issues/498&gt;</code>_)</p>
</li>
<li>
<p>Calling <code>towncrier check</code> without an existing
configuration, will just show only an error message.</p>
<p>In previous versions, a traceback was generated instead of the error
message. (<code>[#501](twisted/towncrier#501)
&lt;https://github.com/twisted/towncrier/issues/501&gt;</code>_)</p>
</li>
</ul>
<h2>Bugfixes</h2>
<ul>
<li>
<p>Fix creating fragment in a section not adding random characters.</p>
<p>For example, <code>towncrier create some_section/+.feature</code>
should end up as a fragment named something like
<code>news/some_section/+a4e22da1.feature</code>.
(<code>[#468](twisted/towncrier#468)
&lt;https://github.com/twisted/towncrier/issues/468&gt;</code>_)</p>
</li>
<li>
<p>Fix the ReadTheDocs build for <code>towncrier</code> which was broken
due to the python version in use being 3.8. Upgrade to 3.11.
(<code>[#509](twisted/towncrier#509)
&lt;https://github.com/twisted/towncrier/issues/509&gt;</code>_)</p>
</li>
</ul>
<h2>Improved Documentation</h2>
<ul>
<li>Moved man page to correct section
(<code>[#470](twisted/towncrier#470)
&lt;https://github.com/twisted/towncrier/issues/470&gt;</code>_)</li>
<li>Update link to Quick Start in configuration.html to point to
Tutorial instead.
(<code>[#504](twisted/towncrier#504)
&lt;https://github.com/twisted/towncrier/issues/504&gt;</code>_)</li>
<li>Add a note about the build command's <code>--version</code>
requiring the command to be explicitly passed.
(<code>[#511](twisted/towncrier#511)
&lt;https://github.com/twisted/towncrier/issues/511&gt;</code>_)</li>
<li>Fix typos in the Pre-Commit docs.
(<code>[#512](twisted/towncrier#512)
&lt;https://github.com/twisted/towncrier/issues/512&gt;</code>_)</li>
</ul>
<h2>Misc</h2>
<ul>
<li><code>[#459](twisted/towncrier#459)
&lt;https://github.com/twisted/towncrier/issues/459&gt;</code><em>,
<code>[#462](twisted/towncrier#462)
&lt;https://github.com/twisted/towncrier/issues/462&gt;</code></em>,
<code>[#472](twisted/towncrier#472)
&lt;https://github.com/twisted/towncrier/issues/472&gt;</code><em>,
<code>[#485](twisted/towncrier#485)
&lt;https://github.com/twisted/towncrier/issues/485&gt;</code></em>,
<code>[#486](twisted/towncrier#486)
&lt;https://github.com/twisted/towncrier/issues/486&gt;</code><em>,
<code>[#487](twisted/towncrier#487)
&lt;https://github.com/twisted/towncrier/issues/487&gt;</code></em>,
<code>[#488](twisted/towncrier#488)
&lt;https://github.com/twisted/towncrier/issues/488&gt;</code><em>,
<code>[#495](twisted/towncrier#495)
&lt;https://github.com/twisted/towncrier/issues/495&gt;</code></em>,
<code>[#497](twisted/towncrier#497)
&lt;https://github.com/twisted/towncrier/issues/497&gt;</code><em>,
<code>[#507](twisted/towncrier#507)
&lt;https://github.com/twisted/towncrier/issues/507&gt;</code></em>,
<code>[#1117](https://github.com/twisted/towncrier/issues/1117)
&lt;https://github.com/twisted/towncrier/issues/1117&gt;</code><em>,
<code>[#513](twisted/towncrier#513)
&lt;https://github.com/twisted/towncrier/issues/513&gt;</code></em></li>
</ul>
<p>towncrier 22.12.0 (2022-12-21)</p>
<!-- raw HTML omitted -->
</blockquote>
<p>... (truncated)</p>
</details>
<details>
<summary>Commits</summary>
<ul>
<li><a
href="https://github.com/twisted/towncrier/commit/22a5b015e6404900bfaed4d218cacbd09fc43916"><code>22a5b01</code></a>
Update for final release.</li>
<li><a
href="https://github.com/twisted/towncrier/commit/0d9f08708a29a65050c907995e05180d5320fa6f"><code>0d9f087</code></a>
Fix news file.</li>
<li><a
href="https://github.com/twisted/towncrier/commit/32d7034b82bef8b9f36b6aaec2e9c0de328de222"><code>32d7034</code></a>
Remove deploy env requirement.</li>
<li><a
href="https://github.com/twisted/towncrier/commit/13e6d0c52e5dd63bf6fbf5434731dc4997ecfc82"><code>13e6d0c</code></a>
Conditionally run the whole publish.</li>
<li><a
href="https://github.com/twisted/towncrier/commit/6b9b85a252cc10a40d024710777df48b53740b9a"><code>6b9b85a</code></a>
Add dedicated environment.</li>
<li><a
href="https://github.com/twisted/towncrier/commit/3deaebd35a38bf89e1e0d92bf7822b3ffa61bda0"><code>3deaebd</code></a>
Add a top title to the release notes.</li>
<li><a
href="https://github.com/twisted/towncrier/commit/a94f23c5e3e410bffd44cefbd961192d28fe76f1"><code>a94f23c</code></a>
Fix NEWS.rst formatting.</li>
<li><a
href="https://github.com/twisted/towncrier/commit/3ba6cd1a1830d53266129770556c3d3ea593fcd6"><code>3ba6cd1</code></a>
Include the release notes in the docs to make it easyier to review the
RST fo...</li>
<li><a
href="https://github.com/twisted/towncrier/commit/1888debeb12afef9406ac997ad1f9e554423832c"><code>1888deb</code></a>
Add info about 3.7.</li>
<li><a
href="https://github.com/twisted/towncrier/commit/b7a561cf5a85fce14e4abc1ea17d8d9ee59d2e60"><code>b7a561c</code></a>
Update for release candidate.</li>
<li>Additional commits viewable in <a
href="https://github.com/twisted/towncrier/compare/22.8.0...23.6.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=22.8.0&new-version=23.6.0)](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 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>
Co-authored-by: dependabot[bot] <dependabot[bot]@users.noreply.github.com>
Co-authored-by: Sam Bull <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@COUR4G3