Task #2179
closed
Document what things are governed by semantic versioning in the 2.y line
Description
We should have docs stating that semantic versioning applies to the:
REST API
pulp-admin interface
plugin API
This is specific to the 2.y line and should land on master if master is still an upcoming 2.y release. It should indicate that the pulp-server version number is the basis for the semantic version.
- Blocks Task #2180: Document the plugin API semver strategy for 3.0 added
I'm not sure why this would block anything about 3.0. Can you elaborate?
There have been some breaking changes to the plugin API in the 2.y line, especially related to the Mongoengine conversion. We should be clear that the plugin API has changed over the 2.y line but there will be no more backwards incompatible changes until the 3.0 release.
mhrivnak wrote:
I'm not sure why this would block anything about 3.0. Can you elaborate?
The thinking was two-fold. 1) That the 3.0 docs would update these docs and 2) that for this task to be practically useful we should do it soon. If you want to remove the blocking relationship I'm OK with that, but maybe groom it also so we can put it onto a sprint soon.
- Blocks deleted (Task #2180: Document the plugin API semver strategy for 3.0)
- Related to Task #2180: Document the plugin API semver strategy for 3.0 added
Thanks for elaborating.
I'm not convinced that this is worth spending time on at this point. I don't expect there will be any new plugin writing happening on the pulp 2 line, so I'm not sure who this will benefit. If someone wants to take 5 minutes to put this in writing and make it official, that sounds fine. As of 2.11 we aren't likely to change much of anything about pulp 2, so this will be an easy guarantee to make. But even 30 minutes spent writing it, building it locally, getting it reviewed, merging it, etc. may be better spent on pulp 3.
This was work that was identified in a group meeting. I would want to hear from more people before we uncommitted from something that a group thought was valuable.
- Sprint Candidate changed from Yes to No
- Status changed from NEW to CLOSED - WONTFIX
Pulp 2 is approaching maintenance mode, and this Pulp 2 ticket is not being actively worked on. As such, it is being closed as WONTFIX. Pulp 2 is still accepting contributions though, so if you want to contribute a fix for this ticket, please reopen or comment on it. If you don't have permissions to reopen this ticket, or you want to discuss an issue, please reach out via the developer mailing list.
Also available in: Atom
PDF