You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@devlake.apache.org by ma...@apache.org on 2022/07/05 07:25:21 UTC
[incubator-devlake-website] branch main updated: fix: add install mockery (#106)
This is an automated email from the ASF dual-hosted git repository.
mappjzc pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/incubator-devlake-website.git
The following commit(s) were added to refs/heads/main by this push:
new b793027 fix: add install mockery (#106)
b793027 is described below
commit b79302792fd183e2102f30c2931face5c5d5079c
Author: mappjzc <jz...@qq.com>
AuthorDate: Tue Jul 5 15:25:17 2022 +0800
fix: add install mockery (#106)
Add install mockery for DeveloperSetup.md.
Nddtfjiang <zh...@merico.dev>
---
docs/DeveloperManuals/04-DeveloperSetup.md | 23 ++++++++++++++---------
1 file changed, 14 insertions(+), 9 deletions(-)
diff --git a/docs/DeveloperManuals/04-DeveloperSetup.md b/docs/DeveloperManuals/04-DeveloperSetup.md
index 62cc1e5..05b676f 100644
--- a/docs/DeveloperManuals/04-DeveloperSetup.md
+++ b/docs/DeveloperManuals/04-DeveloperSetup.md
@@ -31,18 +31,23 @@ description: >
```sh
go get
```
+4. Install mockery
-4. Copy the sample config file to new local file:
+ ```sh
+ go install github.com/vektra/mockery/v2@latest
+ ```
+
+5. Copy the sample config file to new local file:
```sh
cp .env.example .env
```
-5. Update the following variables in the file `.env`:
+6. Update the following variables in the file `.env`:
* `DB_URL`: Replace `mysql:3306` with `127.0.0.1:3306`
-6. Start the MySQL and Grafana containers:
+7. Start the MySQL and Grafana containers:
> Make sure the Docker daemon is running before this step.
@@ -50,7 +55,7 @@ description: >
docker-compose up -d mysql grafana
```
-7. Run lake and config UI in dev mode in two separate terminals:
+8. Run lake and config UI in dev mode in two separate terminals:
```sh
# run lake
@@ -67,7 +72,7 @@ description: >
export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:/usr/local/lib
```
-8. Visit config UI at `localhost:4000` to configure data connections.
+9. Visit config UI at `localhost:4000` to configure data connections.
- Navigate to desired plugins pages on the Integrations page
- Enter the required information for the plugins you intend to use.
- Refer to the following for more details on how to configure each one:
@@ -77,7 +82,7 @@ description: >
- [GitHub](../Plugins/github.md): For users who'd like to collect GitHub data, we recommend reading our [GitHub data collection guide](../UserManuals/github-user-guide-v0.10.0.md) which covers the following steps in detail.
- Submit the form to update the values by clicking on the **Save Connection** button on each form page
-9. Visit `localhost:4000/pipelines/create` to RUN a Pipeline and trigger data collection.
+10. Visit `localhost:4000/pipelines/create` to RUN a Pipeline and trigger data collection.
Pipelines Runs can be initiated by the new "Create Run" Interface. Simply enable the **Data Connection Providers** you wish to run collection for, and specify the data you want to collect, for instance, **Project ID** for Gitlab and **Repository Name** for GitHub.
@@ -110,17 +115,17 @@ description: >
Please refer to [Pipeline Advanced Mode](../UserManuals/create-pipeline-in-advanced-mode.md) for in-depth explanation.
-10. Click *View Dashboards* button in the top left when done, or visit `localhost:3002` (username: `admin`, password: `admin`).
+11. Click *View Dashboards* button in the top left when done, or visit `localhost:3002` (username: `admin`, password: `admin`).
We use <a href="https://grafana.com/" target="_blank">Grafana</a> as a visualization tool to build charts for the <a href="https://github.com/merico-dev/lake/wiki/DataModel.Domain-layer-schema">data stored in our database</a>. Using SQL queries, we can add panels to build, save, and edit customized dashboards.
All the details on provisioning and customizing a dashboard can be found in the [Grafana Doc](../UserManuals/GRAFANA.md).
-11. (Optional) To run the tests:
+12. (Optional) To run the tests:
```sh
make test
```
-12. For DB migrations, please refer to [Migration Doc](../DeveloperManuals/MIGRATIONS.md).
+13. For DB migrations, please refer to [Migration Doc](../DeveloperManuals/MIGRATIONS.md).
<br/><br/><br/>