search

apache / incubator-devlake

Apache DevLake is an open-source dev data platform to ingest, analyze, and visualize the fragmented data from DevOps tools, extracting insights for engineering excellence, developer experience, and community growth.
https://devlake.apache.org/
Apache License 2.0
2.59k stars 521 forks source link

DeveloperManuals/DeveloperSetup missing a step #7495

Closed lhart-intelycare closed 4 months ago

lhart-intelycare commented 5 months ago

Documentation Scope

This provides instructions for installing devlake in dev mode.

Describe the Change

When I get to this section and run "make dev" on MacOS: image When the azuredevops plugin is made:

Building remote plugin: azuredevops/build.sh

I get an error about "poetry" not being installed. I install poetry using these instruction to get by it: https://python-poetry.org/docs/#installing-with-the-official-installer

Seems like a dependency that needs to be called out.

dosubot[bot] commented 5 months ago

It looks like the installation of Poetry is a necessary step for building the azuredevops plugin, and this should be explicitly mentioned in the setup instructions to avoid similar issues.

Here are the steps you should follow to install Poetry and ensure the build process works correctly:

  1. Install Poetry:

  2. Run the following commands:

    • cd backend/python/pydevlake && poetry install
    • cd backend/python/plugins/azuredevops && poetry install

Adding these steps to the DeveloperManuals/DeveloperSetup documentation will help ensure that all necessary dependencies, including Poetry, are installed correctly.

#### Details **Sources** - [[Doc][Community] Add more details to Development Workflow](https://github.com/apache/incubator-devlake/issues/4609) - [backend/python/plugins/azuredevops/build.sh](https://github.com/apache/incubator-devlake/blob/main/backend/python/plugins/azuredevops/build.sh) - [backend/python/plugins/azuredevops/pyproject.toml](https://github.com/apache/incubator-devlake/blob/main/backend/python/plugins/azuredevops/pyproject.toml) - [backend/python/DevelopmentSetup.md](https://github.com/apache/incubator-devlake/blob/main/backend/python/DevelopmentSetup.md)
**About Dosu** This response is meant to be useful and save you time. It is **not meant to be a precise solution**, but rather a starting point for your own research. Help me be more useful! Please leave a 👍 if this is helpful and 👎 if it is irrelevant.

To continue the conversation, mention @dosu.

klesh commented 5 months ago

@lhart-intelycare Would you like to add it to the document? The repo is https://github.com/apache/incubator-devlake-website