You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@devlake.apache.org by zh...@apache.org on 2023/03/31 03:44:32 UTC
[incubator-devlake-website] branch main updated: docs: update gitext refs_commits_diffs to refs_commits (#482)
This is an automated email from the ASF dual-hosted git repository.
zhangliang2022 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 51187e13ae docs: update gitext refs_commits_diffs to refs_commits (#482)
51187e13ae is described below
commit 51187e13ae50288527a3bd03e2aa2cd153816f09
Author: abeizn <zi...@merico.dev>
AuthorDate: Fri Mar 31 11:44:28 2023 +0800
docs: update gitext refs_commits_diffs to refs_commits (#482)
---
docs/Plugins/gitextractor.md | 13 +++++++------
versioned_docs/version-v0.15/Plugins/gitextractor.md | 13 +++++++------
versioned_docs/version-v0.16/Plugins/gitextractor.md | 13 +++++++------
3 files changed, 21 insertions(+), 18 deletions(-)
diff --git a/docs/Plugins/gitextractor.md b/docs/Plugins/gitextractor.md
index a357a845e5..5f93b96eb5 100644
--- a/docs/Plugins/gitextractor.md
+++ b/docs/Plugins/gitextractor.md
@@ -5,14 +5,15 @@ description: >
---
## Summary
+
This plugin extracts commits and references from a remote or local git repository. It then saves the data into the database or csv files.
## Steps to make this plugin work
1. Use the Git repo extractor to retrieve data about commits and branches from your repository.
2. Use the GitHub plugin to retrieve data about Github issues and PRs from your repository.
-NOTE: you can run only one issue collection stage as described in the Github Plugin README.
-3. Use the [RefDiff](./refdiff.md) plugin to calculate version diff, which will be stored in `refs_commits_diffs` table.
+ NOTE: you can run only one issue collection stage as described in the Github Plugin README.
+3. Use the [RefDiff](./refdiff.md) plugin to calculate version diff, which will be stored in `refs_commits` table.
## Sample Request
@@ -36,16 +37,16 @@ curl --location --request POST 'localhost:8080/pipelines' \
}
'
```
+
- `url`: the location of the git repository. It should start with `http`/`https` for a remote git repository and with `/` for a local one.
-- `repoId`: column `id` of `repos`.
- Note : For GitHub, to find the repo id run `$("meta[name=octolytics-dimension-repository_id]").getAttribute('content')` in browser console.
+- `repoId`: column `id` of `repos`.
+ Note : For GitHub, to find the repo id run `$("meta[name=octolytics-dimension-repository_id]").getAttribute('content')` in browser console.
- `proxy`: optional, http proxy, e.g. `http://your-proxy-server.com:1080`.
- `user`: optional, for cloning private repository using HTTP/HTTPS
- `password`: optional, for cloning private repository using HTTP/HTTPS
- `privateKey`: optional, for SSH cloning, base64 encoded `PEM` file
- `passphrase`: optional, passphrase for the private key
-
## Standalone Mode
You call also run this plugin in a standalone mode without any DevLake service running using the following command:
@@ -129,6 +130,6 @@ make install
> `brew install pkg-config`
>
> 2. Make sure your pkg config path covers the installation:
- > `export PKG_CONFIG_PATH=$PKG_CONFIG_PATH:/usr/local/lib:/usr/local/lib/pkgconfig`
+> `export PKG_CONFIG_PATH=$PKG_CONFIG_PATH:/usr/local/lib:/usr/local/lib/pkgconfig`
<br/><br/><br/>
diff --git a/versioned_docs/version-v0.15/Plugins/gitextractor.md b/versioned_docs/version-v0.15/Plugins/gitextractor.md
index a357a845e5..5f93b96eb5 100644
--- a/versioned_docs/version-v0.15/Plugins/gitextractor.md
+++ b/versioned_docs/version-v0.15/Plugins/gitextractor.md
@@ -5,14 +5,15 @@ description: >
---
## Summary
+
This plugin extracts commits and references from a remote or local git repository. It then saves the data into the database or csv files.
## Steps to make this plugin work
1. Use the Git repo extractor to retrieve data about commits and branches from your repository.
2. Use the GitHub plugin to retrieve data about Github issues and PRs from your repository.
-NOTE: you can run only one issue collection stage as described in the Github Plugin README.
-3. Use the [RefDiff](./refdiff.md) plugin to calculate version diff, which will be stored in `refs_commits_diffs` table.
+ NOTE: you can run only one issue collection stage as described in the Github Plugin README.
+3. Use the [RefDiff](./refdiff.md) plugin to calculate version diff, which will be stored in `refs_commits` table.
## Sample Request
@@ -36,16 +37,16 @@ curl --location --request POST 'localhost:8080/pipelines' \
}
'
```
+
- `url`: the location of the git repository. It should start with `http`/`https` for a remote git repository and with `/` for a local one.
-- `repoId`: column `id` of `repos`.
- Note : For GitHub, to find the repo id run `$("meta[name=octolytics-dimension-repository_id]").getAttribute('content')` in browser console.
+- `repoId`: column `id` of `repos`.
+ Note : For GitHub, to find the repo id run `$("meta[name=octolytics-dimension-repository_id]").getAttribute('content')` in browser console.
- `proxy`: optional, http proxy, e.g. `http://your-proxy-server.com:1080`.
- `user`: optional, for cloning private repository using HTTP/HTTPS
- `password`: optional, for cloning private repository using HTTP/HTTPS
- `privateKey`: optional, for SSH cloning, base64 encoded `PEM` file
- `passphrase`: optional, passphrase for the private key
-
## Standalone Mode
You call also run this plugin in a standalone mode without any DevLake service running using the following command:
@@ -129,6 +130,6 @@ make install
> `brew install pkg-config`
>
> 2. Make sure your pkg config path covers the installation:
- > `export PKG_CONFIG_PATH=$PKG_CONFIG_PATH:/usr/local/lib:/usr/local/lib/pkgconfig`
+> `export PKG_CONFIG_PATH=$PKG_CONFIG_PATH:/usr/local/lib:/usr/local/lib/pkgconfig`
<br/><br/><br/>
diff --git a/versioned_docs/version-v0.16/Plugins/gitextractor.md b/versioned_docs/version-v0.16/Plugins/gitextractor.md
index a357a845e5..5f93b96eb5 100644
--- a/versioned_docs/version-v0.16/Plugins/gitextractor.md
+++ b/versioned_docs/version-v0.16/Plugins/gitextractor.md
@@ -5,14 +5,15 @@ description: >
---
## Summary
+
This plugin extracts commits and references from a remote or local git repository. It then saves the data into the database or csv files.
## Steps to make this plugin work
1. Use the Git repo extractor to retrieve data about commits and branches from your repository.
2. Use the GitHub plugin to retrieve data about Github issues and PRs from your repository.
-NOTE: you can run only one issue collection stage as described in the Github Plugin README.
-3. Use the [RefDiff](./refdiff.md) plugin to calculate version diff, which will be stored in `refs_commits_diffs` table.
+ NOTE: you can run only one issue collection stage as described in the Github Plugin README.
+3. Use the [RefDiff](./refdiff.md) plugin to calculate version diff, which will be stored in `refs_commits` table.
## Sample Request
@@ -36,16 +37,16 @@ curl --location --request POST 'localhost:8080/pipelines' \
}
'
```
+
- `url`: the location of the git repository. It should start with `http`/`https` for a remote git repository and with `/` for a local one.
-- `repoId`: column `id` of `repos`.
- Note : For GitHub, to find the repo id run `$("meta[name=octolytics-dimension-repository_id]").getAttribute('content')` in browser console.
+- `repoId`: column `id` of `repos`.
+ Note : For GitHub, to find the repo id run `$("meta[name=octolytics-dimension-repository_id]").getAttribute('content')` in browser console.
- `proxy`: optional, http proxy, e.g. `http://your-proxy-server.com:1080`.
- `user`: optional, for cloning private repository using HTTP/HTTPS
- `password`: optional, for cloning private repository using HTTP/HTTPS
- `privateKey`: optional, for SSH cloning, base64 encoded `PEM` file
- `passphrase`: optional, passphrase for the private key
-
## Standalone Mode
You call also run this plugin in a standalone mode without any DevLake service running using the following command:
@@ -129,6 +130,6 @@ make install
> `brew install pkg-config`
>
> 2. Make sure your pkg config path covers the installation:
- > `export PKG_CONFIG_PATH=$PKG_CONFIG_PATH:/usr/local/lib:/usr/local/lib/pkgconfig`
+> `export PKG_CONFIG_PATH=$PKG_CONFIG_PATH:/usr/local/lib:/usr/local/lib/pkgconfig`
<br/><br/><br/>