jaraco / jaraco/skeleton

Default `towncrier` configuration uses title `Deprecations and Removals` for `.removal.rst` files which clashes with `jaraco.develop.towncrier` assumptions

Open
#169 5 comments 0 reactions 0 assignees View on GitHub
Dominant language
No language data
Stars
150
Forks
38
Avg merge
1m
Merged PRs (30d)
1

Description

By default the section title associated with `.removal.rst` files is "***Deprecations*** and Removals", however this bundles 2 distinct behaviours together according to https://semver.org:

- deprecations are introduced in **minor version** bumps
- removals are done in **major version** bumps.

This clashes with the assumptions in `jaraco.develop.towncrier` (and other projects using it like `setuptools`), which uses `.removal.rst` files for **major version** updates.

We are left with a dilemma:

- If we want a minor version bump, then we need to use a `.feature.rst` file. However this will add changelog lines like "Deprecated feature X" in the `Features` section. Meanwhile the `Deprecations and Removals` will not have any deprecations...
- If we want the deprecations to go to the `Deprecations and Removals` section, then we need to use the `.removal.rst` file. However, this will cause a major version bump (but it should be a minor version bump).

Contributor guide

No contributing guide indexed for this repository

Research direction

Locate the default towncrier configuration and inspect how `.removal.rst` is mapped to its section title. Compare that behavior with the semver expectations described in the issue and the assumptions in `jaraco.develop.towncrier`. Done means deprecations and removals are distinguishable without breaking the major-version handling used by dependent projects.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
release
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.