Backstage backend plugin

[grahambrooks]

I would like to implement a backend plugin to read organizational (user/team to start) as a source of team and user data for devlake.

I have tried importing the core modules into a separate project but they don't seem to be available in the 1.0.1 release?

Is there a recommended approach to developing devlake plugins?

[dosubot[bot]]

Hey @grahambrooks! I'm a bot designed to help you with bugs, questions, and contributions. I'm here to assist you while waiting for a human maintainer.

The recommended approach to developing DevLake plugins, especially for implementing a backend plugin to read organizational data such as user and team information, involves creating a plugin that implements several interfaces like PluginMeta, PluginInit, PluginTask, PluginModel, and ProjectMapper. The Org plugin serves as a useful example.

Here is a brief overview of the approach:

1. Initialization: Implement the Init method to initialize handlers using the api.NewHandlers function.

2. Task Management: Define subtasks and pipeline plans. Use methods like SubTaskMetas to return a list of subtasks and MakePipeline to construct a pipeline plan.

3. API Resources: Define API resources for handling data operations such as GET and PUT for teams and users.

4. Plugin Structure: Organize your plugin into folders such as api, models, and tasks. The api folder interacts with the config-ui, the models folder stores data entities and migration scripts, and the tasks folder contains all subtasks for the plugin.

5. Subtask Creation: Use helper.NewApiCollector and helper.NewApiExtractor to create collectors and extractors for data collection and processing.

For more detailed guidance, you can refer to the Apache DevLake documentation on plugin implementation ^[1][2].

Regarding the availability of core modules in the 1.0.1 release, I couldn't find specific information on this issue. It might be helpful to check the release notes or documentation for any changes or updates that could affect module availability.

To continue talking to Dosu, mention @dosu.

---

^{Help Dosu learn! Give it feedback: Great Response | Irrelevant Answer | Incorrect Sources | Too Verbose | Hallucination | Other}