Project

Profile

Help

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 2 months ago. Updated 28 days ago.

Status:
CLOSED - CURRENTRELEASE
Priority:
Normal
Assignee:
Category:
-
Sprint/Milestone:
Start date:
Due date:
% Done:

100%

Estimated time:
Platform Release:
Groomed:
No
Sprint Candidate:
No
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 2 months ago

Added deprecations to the changelog.

fixes #7415

History

#1 Updated by bmbouter about 2 months ago

  • Parent task set to #7416

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

#3 Updated by daviddavis about 2 months 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.

#4 Updated by pulpbot about 2 months ago

  • Status changed from NEW to POST

#5 Updated by daviddavis about 2 months ago

  • Assignee set to daviddavis

#6 Updated by daviddavis about 2 months ago

  • Sprint set to Sprint 80

#7 Updated by daviddavis about 2 months ago

  • Status changed from POST to MODIFIED
  • % Done changed from 0 to 100

#8 Updated by bmbouter about 1 month ago

  • Sprint/Milestone set to 3.7.0

#9 Updated by pulpbot 28 days ago

  • Status changed from MODIFIED to CLOSED - CURRENTRELEASE

Please register to edit this issue

Also available in: Atom PDF