Make `towncrier create` increment fragments rather than failing #475

SmileyChris · 2023-02-09T01:39:51Z

Description

$ ls src/towncrier/newsfragments
459.misc  462.misc  470.doc  472.misc  
$ towncrier create 459.misc
Created news fragment at /home/chris/dev/towncrier/src/towncrier/newsfragments/459.misc.1
$ ls src/towncrier/newsfragments
459.misc  459.misc.1  462.misc  470.doc  472.misc

Checklist

Make sure changes are covered by existing or new tests.
For at least one Python version, make sure local test run is green.
Create a file in src/towncrier/newsfragments/. Describe your
change and include important information. Your change will be included in the public release notes.
Make sure all GitHub Actions checks are green (they are automatically checking all of the above).
Ensure docs/tutorial.rst is still up-to-date.

Fixes twisted#474

codecov · 2023-02-09T01:48:54Z

Codecov Report

Base: 100.00% // Head: 100.00% // No change to project coverage 👍

Coverage data is based on head (bc7e33c) compared to base (566d315).
Patch coverage: 100.00% of modified lines in pull request are covered.

Additional details and impacted files

@@            Coverage Diff            @@
##             trunk      #475   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           13        13           
  Lines          622       627    +5     
  Branches       144       145    +1     
=========================================
+ Hits           622       627    +5

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

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

glyph

I don't quite understand what the use-case is here. If a bug is fixed in a release, it can only be fixed once. If a feature is added, it can only be added once.

If there is a clear reason to do this, it should be 1234-1.bugfix rather than 1234.bugfix.1, since .bugfix is the extension here (which indicates the file type) and not a .1 (which would be a man page).

Thanks for taking the time to contribute to towncrier!

hynek · 2023-02-14T07:09:22Z

I think 1234-1.bugfix is better too, because part of my secret todo list it 123,456.bugfix so I don’t have to keep multiple news fragments in sync, just to have an entry point to multiple issues. 123-1,456.bugfix would work because it’s unequivocal.

That said, I don’t see much sense in that, you can just edit the old news fragment or is this about pacifying bots that require a new news fragment?

pawelad · 2023-02-14T11:28:37Z

Isn't this just adding support for an already implemented counter feature (https://github.com/twisted/towncrier/search?q=counter) to the towncrier create command?

And FWIW, for us the use case for is having multiple changelog entries (of the same type) linked to one issue. I understand (and agree) that one PR / issue should be about one thing, but unfortunately it isn't always the case for us.
I was pleased to find that towncrier already has support for that through the optional counter in the filename, but was then surprised that towncrier create doesn't support it, hence #474

src/towncrier/test/test_create.py

docs/tutorial.rst

adiroiban · 2023-02-15T09:45:23Z

Thanks @pawelad for the head up.

I can see that the "counter" functionality was added here #119

I think that the current team of maintainers is not aware of that functionality, and we would all like not to have the counter as a "file extension".

It looks like the counter feature was added without documentation...but I think that by then, there was no documentation for towncrier.

So, I think that this should be merged with the counter as an extension.

Later, we can see if we can refactor this not to have the counter as an extension.

I think that towncrier also has support for 459.misc.rst ... if the counter feature works as 459.misc.1.rst I think that we are fine.

…nality

SmileyChris · 2023-02-20T20:19:03Z

Ok, I've fixed those minor suggestions for you @adiroiban.

As you've discovered, this is just functionality that towncrier has already, being surfaced more clearly. Hopefully @glyph agrees, I've re-requested him to review.

glyph

OK. Sounds good. Discussion of improving this feature will go elsewhere.

adiroiban · 2023-02-21T00:11:50Z

Many thanks, Chris for the PR and Glyph for the review.
I was not aware of this functionality in towncrier... you learn something new every day :)

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 & 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>  </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) <https://github.com/twisted/towncrier/issues/475></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) <https://github.com/twisted/towncrier/issues/483></code>_)</p> </li> <li> <p>Towncrier no longer depends on setuptools & uses importlib.resources (or its backport) instead. (<code>[#496](twisted/towncrier#496) <https://github.com/twisted/towncrier/issues/496></code>_)</p> </li> <li> <p>Added pre-commit hooks for checking and updating news in projects using pre-commit. (<code>[#498](twisted/towncrier#498) <https://github.com/twisted/towncrier/issues/498></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) <https://github.com/twisted/towncrier/issues/501></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) <https://github.com/twisted/towncrier/issues/468></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) <https://github.com/twisted/towncrier/issues/509></code>_)</p> </li> </ul> <h2>Improved Documentation</h2> <ul> <li>Moved man page to correct section (<code>[#470](twisted/towncrier#470) <https://github.com/twisted/towncrier/issues/470></code>_)</li> <li>Update link to Quick Start in configuration.html to point to Tutorial instead. (<code>[#504](twisted/towncrier#504) <https://github.com/twisted/towncrier/issues/504></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) <https://github.com/twisted/towncrier/issues/511></code>_)</li> <li>Fix typos in the Pre-Commit docs. (<code>[#512](twisted/towncrier#512) <https://github.com/twisted/towncrier/issues/512></code>_)</li> </ul> <h2>Misc</h2> <ul> <li><code>[#459](twisted/towncrier#459) <https://github.com/twisted/towncrier/issues/459></code><em>, <code>[#462](twisted/towncrier#462) <https://github.com/twisted/towncrier/issues/462></code></em>, <code>[#472](twisted/towncrier#472) <https://github.com/twisted/towncrier/issues/472></code><em>, <code>[#485](twisted/towncrier#485) <https://github.com/twisted/towncrier/issues/485></code></em>, <code>[#486](twisted/towncrier#486) <https://github.com/twisted/towncrier/issues/486></code><em>, <code>[#487](twisted/towncrier#487) <https://github.com/twisted/towncrier/issues/487></code></em>, <code>[#488](twisted/towncrier#488) <https://github.com/twisted/towncrier/issues/488></code><em>, <code>[#495](twisted/towncrier#495) <https://github.com/twisted/towncrier/issues/495></code></em>, <code>[#497](twisted/towncrier#497) <https://github.com/twisted/towncrier/issues/497></code><em>, <code>[#507](twisted/towncrier#507) <https://github.com/twisted/towncrier/issues/507></code></em>, <code>[#1117](https://github.com/twisted/towncrier/issues/1117) <https://github.com/twisted/towncrier/issues/1117></code><em>, <code>[#513](twisted/towncrier#513) <https://github.com/twisted/towncrier/issues/513></code></em></li> </ul> <p>towncrier 22.12.0 (2022-12-21)</p>  </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] <support@github.com> 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 <git@sambull.org>

SmileyChris added 2 commits February 9, 2023 14:33

Make towncrier create increment fragments rather than failing

bf820d5

Fixes twisted#474

Rename change file

37a7363

SmileyChris marked this pull request as ready for review February 9, 2023 01:46

SmileyChris requested a review from a team as a code owner February 9, 2023 01:46

Add example to tutorial of incrementing via towncrier create

811ce1e

SmileyChris force-pushed the feature/create-fragment-increment branch from 6f86444 to 811ce1e Compare February 9, 2023 01:48

Merge branch 'trunk' into feature/create-fragment-increment

c918a15

glyph requested changes Feb 14, 2023

View reviewed changes

adiroiban reviewed Feb 15, 2023

View reviewed changes

src/towncrier/test/test_create.py Outdated Show resolved Hide resolved

adiroiban reviewed Feb 15, 2023

View reviewed changes

docs/tutorial.rst Outdated Show resolved Hide resolved

SmileyChris added 2 commits February 21, 2023 09:13

Remove the counter example from the tutorial, this isn't core functio…

20eebc8

…nality

Better docstring for the new test

bc7e33c

SmileyChris requested a review from glyph February 20, 2023 20:18

glyph approved these changes Feb 20, 2023

View reviewed changes

glyph merged commit 826beac into twisted:trunk Feb 20, 2023

SmileyChris deleted the feature/create-fragment-increment branch May 7, 2023 21:56

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Make `towncrier create` increment fragments rather than failing #475

Make `towncrier create` increment fragments rather than failing #475

SmileyChris commented Feb 9, 2023 •

edited

Loading

codecov bot commented Feb 9, 2023 •

edited

Loading

glyph left a comment

hynek commented Feb 14, 2023

pawelad commented Feb 14, 2023 •

edited

Loading

adiroiban commented Feb 15, 2023

SmileyChris commented Feb 20, 2023

glyph left a comment

adiroiban commented Feb 21, 2023

Make towncrier create increment fragments rather than failing #475

Make towncrier create increment fragments rather than failing #475

Conversation

SmileyChris commented Feb 9, 2023 • edited Loading

Description

Checklist

codecov bot commented Feb 9, 2023 • edited Loading

Codecov Report

glyph left a comment

Choose a reason for hiding this comment

hynek commented Feb 14, 2023

pawelad commented Feb 14, 2023 • edited Loading

adiroiban commented Feb 15, 2023

SmileyChris commented Feb 20, 2023

glyph left a comment

Choose a reason for hiding this comment

adiroiban commented Feb 21, 2023

Make `towncrier create` increment fragments rather than failing #475

Make `towncrier create` increment fragments rather than failing #475

SmileyChris commented Feb 9, 2023 •

edited

Loading

codecov bot commented Feb 9, 2023 •

edited

Loading

pawelad commented Feb 14, 2023 •

edited

Loading