twisted/towncrier (towncrier)
### [`v24.7.1`](https://togithub.com/twisted/towncrier/releases/tag/24.7.1): Towncrier 24.7.1
[Compare Source](https://togithub.com/twisted/towncrier/compare/24.7.0...24.7.1)
#### Towncrier 24.7.1 (2024-07-31)
##### Bugfixes
- When the template file is stored in the same directory with the news
fragments, it is automatically ignored when checking for valid
fragment file names.
([#632](https://togithub.com/twisted/towncrier/issues/632))
##### Misc
- [#629](https://togithub.com/twisted/towncrier/issues/629),
[#630](https://togithub.com/twisted/towncrier/issues/630)
### [`v24.7.0`](https://togithub.com/twisted/towncrier/releases/tag/24.7.0): Towncrier 24.7.0
[Compare Source](https://togithub.com/twisted/towncrier/compare/23.11.0...24.7.0)
#### Towncrier 24.7.0 (2024-07-31)
##### Features
- `towncrier build` now handles removing news fragments which are not part of the git repository. For example, uncommitted or unstaged files. ([#357](https://togithub.com/twisted/towncrier/issues/357))
- Inferring the version of a Python package now tries to use the metadata of the installed package before importing the package explicitly (which only looks for `[package].__version__`). ([#432](https://togithub.com/twisted/towncrier/issues/432))
- If no filename is given when doing `towncrier` create, interactively ask for the issue number and fragment type (and then launch an interactive editor for the fragment content).
Now by default, when creating a fragment it will be appended with the `filename` option's extension (unless an extension is explicitly provided). For example, `towncrier create 123.feature` will create `news/123.feature.rst`. This can be changed in configuration file by setting add_extension = false.
A new line is now added by default to the end of the fragment contents. This can be reverted in the configuration file by setting add_newline = false. ([#482](https://togithub.com/twisted/towncrier/issues/482))
- The temporary file `towncrier create` creates now uses the correct `.rst` or `.md` extension, which may help your editor with with syntax highlighting. ([#594](https://togithub.com/twisted/towncrier/issues/594))
- Running `towncrier` will now traverse back up directories looking for the configuration file. ([#601](https://togithub.com/twisted/towncrier/issues/601))
- The `towncrier create` action now uses sections defined in your config (either interactively, or via the new `--section` option). ([#603](https://togithub.com/twisted/towncrier/issues/603))
- News fragments are now sorted by issue number even if they have non-digit characters.
For example:
- some issue (gh-3, gh-10)
- another issue (gh-4)
- yet another issue (gh-11)
The sorting algorithm groups the issues first by non-text characters and then by number. ([#608](https://togithub.com/twisted/towncrier/issues/608))
- The `title_format` configuration option now uses a markdown format for markdown templates. ([#610](https://togithub.com/twisted/towncrier/issues/610))
- newsfragment categories can now be marked with `check = false`, causing them to be ignored in `towncrier check` ([#617](https://togithub.com/twisted/towncrier/issues/617))
- `towncrier check` will now fail if any news fragments have invalid filenames.
Added a new configuration option called `ignore` that allows you to specify a list of filenames that should be ignored. If this is set, `towncrier build` will also fail if any filenames are invalid, except for those in the list. ([#622](https://togithub.com/twisted/towncrier/issues/622))
##### Bugfixes
- Add explicit encoding to read_text. ([#561](https://togithub.com/twisted/towncrier/issues/561))
- The default Markdown template now renders a title containing the release version and date, even when the name configuration is left empty. ([#587](https://togithub.com/twisted/towncrier/issues/587))
- Orphan news fragments, fragments not associated with an issue, consisting of only digits (e.g. '+12345678.feature') now retain their leading marker character. ([#588](https://togithub.com/twisted/towncrier/issues/588))
- Orphan news fragments, fragments not associated with an issue, will now still show in categories that are marked to not show content, since they do not have an issue number to show. ([#612](https://togithub.com/twisted/towncrier/issues/612))
##### Improved Documentation
- Clarify version discovery behavior. ([#432](https://togithub.com/twisted/towncrier/issues/432), [#602](https://togithub.com/twisted/towncrier/issues/602))
- The tutorial now introduces the filename option in the appropriate paragraph and mentions its default value. ([#586](https://togithub.com/twisted/towncrier/issues/586))
- Add docs to explain how `towncrier create +.feature.rst` (orphan fragments) works. ([#589](https://togithub.com/twisted/towncrier/issues/589))
##### Misc
- [#491](https://togithub.com/twisted/towncrier/issues/491), [#561](https://togithub.com/twisted/towncrier/issues/561), [#562](https://togithub.com/twisted/towncrier/issues/562), [#568](https://togithub.com/twisted/towncrier/issues/568), [#569](https://togithub.com/twisted/towncrier/issues/569), [#571](https://togithub.com/twisted/towncrier/issues/571), [#574](https://togithub.com/twisted/towncrier/issues/574), [#575](https://togithub.com/twisted/towncrier/issues/575), [#582](https://togithub.com/twisted/towncrier/issues/582), [#591](https://togithub.com/twisted/towncrier/issues/591), [#596](https://togithub.com/twisted/towncrier/issues/596), [#597](https://togithub.com/twisted/towncrier/issues/597), [#625](https://togithub.com/twisted/towncrier/issues/625)
Configuration
📅 Schedule: Branch creation - "every weekday" (UTC), Automerge - At any time (no schedule defined).
🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.
♻ Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.
🔕 Ignore: Close this PR and you won't be reminded about this update again.
[ ] If you want to rebase/retry this PR, check this box
This PR contains the following updates:
^23.6.0->^23.6.0 \|\| ^24.0.0Release Notes
twisted/towncrier (towncrier)
### [`v24.7.1`](https://togithub.com/twisted/towncrier/releases/tag/24.7.1): Towncrier 24.7.1 [Compare Source](https://togithub.com/twisted/towncrier/compare/24.7.0...24.7.1) #### Towncrier 24.7.1 (2024-07-31) ##### Bugfixes - When the template file is stored in the same directory with the news fragments, it is automatically ignored when checking for valid fragment file names. ([#632](https://togithub.com/twisted/towncrier/issues/632)) ##### Misc - [#629](https://togithub.com/twisted/towncrier/issues/629), [#630](https://togithub.com/twisted/towncrier/issues/630) ### [`v24.7.0`](https://togithub.com/twisted/towncrier/releases/tag/24.7.0): Towncrier 24.7.0 [Compare Source](https://togithub.com/twisted/towncrier/compare/23.11.0...24.7.0) #### Towncrier 24.7.0 (2024-07-31) ##### Features - `towncrier build` now handles removing news fragments which are not part of the git repository. For example, uncommitted or unstaged files. ([#357](https://togithub.com/twisted/towncrier/issues/357)) - Inferring the version of a Python package now tries to use the metadata of the installed package before importing the package explicitly (which only looks for `[package].__version__`). ([#432](https://togithub.com/twisted/towncrier/issues/432)) - If no filename is given when doing `towncrier` create, interactively ask for the issue number and fragment type (and then launch an interactive editor for the fragment content). Now by default, when creating a fragment it will be appended with the `filename` option's extension (unless an extension is explicitly provided). For example, `towncrier create 123.feature` will create `news/123.feature.rst`. This can be changed in configuration file by setting add_extension = false. A new line is now added by default to the end of the fragment contents. This can be reverted in the configuration file by setting add_newline = false. ([#482](https://togithub.com/twisted/towncrier/issues/482)) - The temporary file `towncrier create` creates now uses the correct `.rst` or `.md` extension, which may help your editor with with syntax highlighting. ([#594](https://togithub.com/twisted/towncrier/issues/594)) - Running `towncrier` will now traverse back up directories looking for the configuration file. ([#601](https://togithub.com/twisted/towncrier/issues/601)) - The `towncrier create` action now uses sections defined in your config (either interactively, or via the new `--section` option). ([#603](https://togithub.com/twisted/towncrier/issues/603)) - News fragments are now sorted by issue number even if they have non-digit characters. For example: - some issue (gh-3, gh-10) - another issue (gh-4) - yet another issue (gh-11) The sorting algorithm groups the issues first by non-text characters and then by number. ([#608](https://togithub.com/twisted/towncrier/issues/608)) - The `title_format` configuration option now uses a markdown format for markdown templates. ([#610](https://togithub.com/twisted/towncrier/issues/610)) - newsfragment categories can now be marked with `check = false`, causing them to be ignored in `towncrier check` ([#617](https://togithub.com/twisted/towncrier/issues/617)) - `towncrier check` will now fail if any news fragments have invalid filenames. Added a new configuration option called `ignore` that allows you to specify a list of filenames that should be ignored. If this is set, `towncrier build` will also fail if any filenames are invalid, except for those in the list. ([#622](https://togithub.com/twisted/towncrier/issues/622)) ##### Bugfixes - Add explicit encoding to read_text. ([#561](https://togithub.com/twisted/towncrier/issues/561)) - The default Markdown template now renders a title containing the release version and date, even when the name configuration is left empty. ([#587](https://togithub.com/twisted/towncrier/issues/587)) - Orphan news fragments, fragments not associated with an issue, consisting of only digits (e.g. '+12345678.feature') now retain their leading marker character. ([#588](https://togithub.com/twisted/towncrier/issues/588)) - Orphan news fragments, fragments not associated with an issue, will now still show in categories that are marked to not show content, since they do not have an issue number to show. ([#612](https://togithub.com/twisted/towncrier/issues/612)) ##### Improved Documentation - Clarify version discovery behavior. ([#432](https://togithub.com/twisted/towncrier/issues/432), [#602](https://togithub.com/twisted/towncrier/issues/602)) - The tutorial now introduces the filename option in the appropriate paragraph and mentions its default value. ([#586](https://togithub.com/twisted/towncrier/issues/586)) - Add docs to explain how `towncrier create +.feature.rst` (orphan fragments) works. ([#589](https://togithub.com/twisted/towncrier/issues/589)) ##### Misc - [#491](https://togithub.com/twisted/towncrier/issues/491), [#561](https://togithub.com/twisted/towncrier/issues/561), [#562](https://togithub.com/twisted/towncrier/issues/562), [#568](https://togithub.com/twisted/towncrier/issues/568), [#569](https://togithub.com/twisted/towncrier/issues/569), [#571](https://togithub.com/twisted/towncrier/issues/571), [#574](https://togithub.com/twisted/towncrier/issues/574), [#575](https://togithub.com/twisted/towncrier/issues/575), [#582](https://togithub.com/twisted/towncrier/issues/582), [#591](https://togithub.com/twisted/towncrier/issues/591), [#596](https://togithub.com/twisted/towncrier/issues/596), [#597](https://togithub.com/twisted/towncrier/issues/597), [#625](https://togithub.com/twisted/towncrier/issues/625)Configuration
📅 Schedule: Branch creation - "every weekday" (UTC), Automerge - At any time (no schedule defined).
🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.
♻ Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.
🔕 Ignore: Close this PR and you won't be reminded about this update again.
This PR was generated by Mend Renovate. View the repository job log.