Task #7415
closed
Story #7416: [Epic] As a plugin user, I can use the next verison of pulpcore without upgrading my plugin
Add CHANGES/plugin_api/.depcrecated changelog entry type
100%
Description
With pulpcore 3.7, backwards incompatible changes in the plugin API will need to be depcrecated for 1-release before being removed.
To do this effectively we need to have a new changelog type made.
To Do¶
Add a new changelog type which will be included in the plugin API portion of the changelog. The new changelog type should be .deprecated. So if issue 1234 introduces a breaking change the PR would include a CHANGES/plugin_api/1234.deprecated call out of the deprecated function/object.
Updated by daviddavis almost 3 years ago
I found a few other examples of other people using towncrier to document deprecations and they use 'deprecation' as the extension, which I'm prone to since it fits with bugfix and feature (noun vs past-tense verb). Happy to consider 'deprecated' instead though.
Updated by daviddavis almost 3 years ago
Also, I'm thinking we shouldn't limit this to the plugin api? Not sure it's possible to scope to the plugin api and it'd be more work to do so.
I rolled it out to plugins too as I figured they might want to deprecate things ahead of a major release.
Updated by pulpbot almost 3 years ago
- Status changed from NEW to POST
Added by daviddavis almost 3 years ago
Updated by daviddavis almost 3 years ago
- Status changed from POST to MODIFIED
- % Done changed from 0 to 100
Applied in changeset pulpcore|c6cef652e0a0ada1d43536c07fe28d2dfaec39aa.
Updated by pulpbot over 2 years ago
- Status changed from MODIFIED to CLOSED - CURRENTRELEASE
.
Added deprecations to the changelog.
fixes #7415