Releases: repobee/repobee-plug
repobee-plug v0.12.0
repobee-plug v0.12.0 release notes
This release introduces a major overhaul of the plugin system. The plugin architecture has been restructured to revolve around tasks (see the docs for more info). Almost every single change listed in the Features section below is backwards incompatible. Extension command plugins are more or less unchanged, but plugins that hooked into e.g. the clone hooks are entirely changed. The is some scaffolding for backwards compatibility, but it's not flawless. For example, an act_on_cloned_repo implementation that lacks the api argument will simply not work anymore, but if it has both the path and api arguments, it will work fine.
The documentation has been completely overhauled as well, and there are now tutorials both for creating task and extension command plugins. It should hopefully be much better now!
TL;DR: Many internal changes to the plugin system, if you have a plugin test that it still works. And read the new docs!
Features
- c44ac97 Require requires_api=True to use REPO_DISCOVERY, fix #54
- 01f9fca Add complete backwards compatibility with HookResult
- 6ea54de Add REPO_DISCOVERY to BaseParser, fix #45
- abc4547 Add discover_repos to APISpec, fix #44
- 26a098e 41b4f22 Introduce helpers for dealing with deprecation
- 38d518f Finalize Task data structure, fix #36
- 30ac4b0 Add clone_task hook, fix #37
- 52acd46 Add setup_task hook, fix #38
- 1d9d9d0 Add initial version of Task data structure #36
Bugfixes
- e35296f Add backward compatibility for HookResult
- e4a1e41 Add call to _not_implemented in APISpec.discover_repos
- 578032f Add setup_hook to the list of allowed hook names
Documentation
- 888ec69 Correct the type hint for the ExtensionCommand callback, fix #55
- a88911a Add section on creating extension commands
- aeb904b Fix bad text role
- b332b63 Remove empty implementing.rst file
- 59c6043 Improve the documentation for the containers, fix #48
- 12c3d54 Reorganize documentation of the public API, fix #50
- 145e1fa Update the documentation for the Plugin class, fix #49
- 05e368e Document the new task-based plugin architecture, fix #39
- cbfbde3 Update documentation for the Task data structure, fix #47
- c128b9c Include APISpec in the public API
- df1bf38 Add note about deprecation of act_on_cloned_repo
Refactorings
- a5c0bde Remove Task.handle_config, fix #56
- fe9453e Rename BaseParser.REPO_DISCOVERY_PARSER to BaseParser.REPO_DISCOVERY
- a1f4b7a Refactor the HookResult tuple into the Result tuple, fix #51
- 0faaaa2 Prefix all internal modules with underscore, fix #42
Other
repobee-plug v0.8.0
repobee-plug v0.8.0 release notes
Breaking changes
- cd3e7f9 Refactor generate_review_allocations hook (#25)
- The signature and semantics of the hook have changed, see the docs for details
Features
Documentation
Other
- 12b213e Fix tag regex in .travis.yml
repobee-plug v0.7.0
repobee-plug v0.6.0
repobee-plug v0.5.1
repobee-plug v0.5.0
Changelog
- 23f6e4d
repomate-plugis nowrepobee-plug
repomate-plug v0.4.1
Changelog
- 6c28df9 Fix an issue related to outdated version of pluggy
repomate-plug v0.4.0
Changelog
- 72e97ba Add peer review hook and refactor into core/extension hooks
- Bunch of updates to documentation
repomate-plug v0.3.0
Changelog
- dc7726d
act_on_cloned_repohook now takes anapiparameter, so that a plugin can e.g. open/close issues.