Task #7415: Add CHANGES/plugin_api/.depcrecated changelog entry type - Pulp

Send by e-mail

Task #7415

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

Added by bmbouter about 1 year ago. Updated about 1 year ago.

Status:

CLOSED - CURRENTRELEASE

Priority:

Normal

Assignee:

daviddavis

Category:

Sprint/Milestone:

3.7.0

Start date:

Due date:

% Done:

100%

Estimated time:

Platform Release:

Groomed:

Sprint Candidate:

Tags:

Sprint:

Sprint 80

Quarter:

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.

Associated revisions

Revision c6cef652 View on GitHub
Added by daviddavis about 1 year ago

Added deprecations to the changelog.

fixes #7415

History

#1 Updated by bmbouter about 1 year ago

Parent task set to #7416

#2 Updated by daviddavis about 1 year 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.