Task #5580
closedMove pulpcore-plugin code into pulp/pulpcore and delete pulp/pulpcore-plugin
100%
Description
Having pulpcore-plugin and pulpcore in separate repos brings many challenges (see below), and a few benefits. Let's make things much simpler by deleting the pulpcore-plugin repository and moving all code to pulp/pulpcore repository.
Challenges motivating the change¶
- Releasing two things makes releasing twice as long and difficult. This has been a practical issue recently.
- Many (majority?) of the objects in pulpcore-plugin import from pulpcore itself, so when you make changes to pulpcore you have to do extra work to add the changelog for plugin writers to pulpcore-plugin. Merging these together would let you make 1 PR.
- It forces us to have two documentation sites. Not only is this extra work for us, but it makes our actual plugin docs difficult to find.
- Coordinating "Required PR:" checkouts is a bunch of extra work (for the CI maintainers).
Why did we originally do it?¶
There are a few reasons I remember:
1. It clearly marked which APIs are governed by the plugin API. You can be sure you're plugin is OK as long as you always import from pulpcore.plugin.
2. We could version the Plugin API at < 1.0 so that we could modify things in a backwards incompatible way in the Y stream still as long as < 1.0.
3. it allowed us to release pulpcore-plugin separately. (This didn't work in practice though because so many objects from pulpcore-plugin are imported from pulpcore, you can't release them separately...)
Of all of these (1) is the most important.
The plan¶
Move all code from pulpcore-plugin to pulpcore. Have the version of pulpcore-plugin still declare 0.1.0, but remove it's setup.py since it won't be a separately installable package. Merge the test dependencies, dependencies, and docs.
We should port the changelog and have the pulpcore package report on the pulpcore.plugin changelog also.
Plugins will then delcare dependency on pulpcore directly. Overall this will make Pulp simpler for everyone.
We'll still have pulpcore.plugin, it'll just be in the github.com/pulp/pulpcore repo. This allows us to still clearly mark exactly what is included in the plugin API (benefit 1).
We can document in the plugin_api docs that the 3.Y versions of the plugin API may change backwards incompatibly so plugins should declare compatability only with the current 3.Y release until it's stable. (This achieves benefit 2).
Related issues
Updated by daviddavis about 5 years ago
This all looks good to me. One question: where would the plugin code live? github.com/pulp/pulpcore/plugin
?
Updated by bmbouter about 5 years ago
daviddavis wrote:
This all looks good to me. One question: where would the plugin code live inside the pulpcore repo?
pulpcore/plugin
?
Yes it would go there. A new 'plugin' folder in this dir: https://github.com/pulp/pulpcore/tree/master/pulpcore
Updated by daviddavis about 5 years ago
- Sprint/Milestone set to 3.0.0
- Groomed changed from No to Yes
- Sprint set to Sprint 60
Updated by bmbouter about 5 years ago
- Sprint deleted (
Sprint 60)
I took off the sprint pending more discussion on the list.
Updated by dalley about 5 years ago
- Status changed from NEW to POST
- Assignee set to dalley
https://github.com/pulp/pulpcore/pull/347
https://github.com/pulp/plugin_template/pull/131
https://github.com/pulp/ansible-pulp/pull/184
https://github.com/pulp/pulp_file/pull/298
https://github.com/pulp/pulp_rpm/pull/1478
https://github.com/pulp/pulp_docker/pull/434
https://github.com/pulp/pulp_ansible/pull/239
https://github.com/pulp/pulp_python/pull/262
https://github.com/pulp/pulp_maven/pull/24
https://github.com/pulp/pulp-2to3-migration/pull/40
Added by dalley about 5 years ago
Added by dalley about 5 years ago
Revision 029130cd | View on GitHub
Depend on pulpcore directly instead of pulpcore-plugin
Required PR: https://github.com/pulp/pulpcore/pull/347
Added by dalley about 5 years ago
Revision 4ca6ce8a | View on GitHub
Depend on pulpcore directly instead of pulpcore-plugin
Required PR: https://github.com/pulp/pulpcore/pull/347 Required PR: https://github.com/pulp/ansible-pulp/pull/184
Added by dalley about 5 years ago
Revision 0274a15d | View on GitHub
Depend on pulpcore directly instead of pulpcore-plugin
Required PR: https://github.com/pulp/pulpcore/pull/347
Added by dalley about 5 years ago
Revision 0274a15d | View on GitHub
Depend on pulpcore directly instead of pulpcore-plugin
Required PR: https://github.com/pulp/pulpcore/pull/347
Added by dalley about 5 years ago
Revision 0274a15d | View on GitHub
Depend on pulpcore directly instead of pulpcore-plugin
Required PR: https://github.com/pulp/pulpcore/pull/347
Added by dalley about 5 years ago
Revision 0274a15d | View on GitHub
Depend on pulpcore directly instead of pulpcore-plugin
Required PR: https://github.com/pulp/pulpcore/pull/347
Added by dalley about 5 years ago
Revision 46d639dd | View on GitHub
Depend on pulpcore directly instead of pulpcore-plugin
Required PR: https://github.com/pulp/pulpcore/pull/347
Added by dalley about 5 years ago
Revision 56da7aa8 | View on GitHub
Update Travis config for the removal of pulpcore-plugin
Required PR: https://github.com/pulp/pulpcore/pull/347
Added by dalley about 5 years ago
Revision 56da7aa8 | View on GitHub
Update Travis config for the removal of pulpcore-plugin
Required PR: https://github.com/pulp/pulpcore/pull/347
Added by dalley about 5 years ago
Revision 56da7aa8 | View on GitHub
Update Travis config for the removal of pulpcore-plugin
Required PR: https://github.com/pulp/pulpcore/pull/347
Updated by dalley about 5 years ago
- Related to Task #5612: Fix plugin API docs added
Added by dalley about 5 years ago
Revision ed043681 | View on GitHub
Move pulpcore-plugin into pulpcore as a subpackage
Added by dalley about 5 years ago
Revision 196425b1 | View on GitHub
Depend on pulpcore directly instead of pulpcore-plugin
Required PR: https://github.com/pulp/pulpcore/pull/347
Added by dalley about 5 years ago
Revision 62e6a3b2 | View on GitHub
Move pulpcore-plugin into pulpcore as a subpackage
Added by dalley about 5 years ago
Revision 4e45c4a0 | View on GitHub
Move pulpcore-plugin documentation
Added by dalley about 5 years ago
Revision 133e935c | View on GitHub
Update Travis config for the removal of pulpcore-plugin
Required PR: https://github.com/pulp/pulpcore/pull/347
re: #5580 ihttps://pulp.plan.io/issues/5580
Added by dalley about 5 years ago
Revision 133e935c | View on GitHub
Update Travis config for the removal of pulpcore-plugin
Required PR: https://github.com/pulp/pulpcore/pull/347
re: #5580 ihttps://pulp.plan.io/issues/5580
Added by dalley about 5 years ago
Revision 2793e002 | View on GitHub
Update submodules, remove references to pulpcore-plugin
Updated by dalley about 5 years ago
- Status changed from POST to MODIFIED
- % Done changed from 0 to 100
Applied in changeset pulplift|2793e002a383a5dfda319130aa47da947f65dd92.
Updated by bmbouter almost 5 years ago
- Status changed from MODIFIED to CLOSED - CURRENTRELEASE
Depend on pulpcore directly instead of pulpcore-plugin
Required PR: https://github.com/pulp/pulpcore/pull/347
re: #5580 https://pulp.plan.io/issues/5580