Startrekzky commented on code in PR #374:
URL:
https://github.com/apache/incubator-devlake-website/pull/374#discussion_r1063132642
##########
docs/UserManuals/ConfigUI/AdvancedMode.md:
##########
@@ -33,7 +33,41 @@ Advanced mode gives utmost flexibility to users by exposing
the JSON API.
## Examples
-### 1. Gitlab
+### 1. GitHub
+
+Collect multiple GitHub repos sequentially. Below is an example for collecting
2 GitHub repos sequentially. It has 2 stages, each contains a GitHub task.
+
+```
+[
+ [
+ {
+ "Plugin": "github",
+ "Options": {
+ "connectionId": 1,
+ "repo": "incubator-devlake",
+ "owner": "apache"
+ }
+ },
+ {
+ "Plugin": "github",
+ "Options": {
+ "connectionId": 1,
+ "repo": "lake",
+ "owner": "merico-dev"
+ }
+ }
+ ]
+]
+```
+
+GitHub:
+
+- `connectionId`: The `ID` field from **Connections GitHub** page.
Review Comment:
The `ID` of your GitHub connection at page {Config-ui URL}/connections/github
##########
docs/UserManuals/ConfigUI/AdvancedMode.md:
##########
@@ -47,92 +81,114 @@ Below is an example for collecting 2 GitLab repos
sequentially. It has 2 stages,
{
"Plugin": "gitlab",
"Options": {
- "projectId": 15238074
+ "connectionId": 1,
+ "projectId": 152***74
}
}
],
[
{
"Plugin": "gitlab",
"Options": {
- "projectId": 11624398
+ "connectionId": 2,
+ "projectId": 116***98
}
}
]
]
```
-### 2. Github
-Collect a GitHub repo and a Jira board in parallel
+### 3. Jenkins
-Below is an example for collecting a GitHub repo and a Jira board in parallel.
It has a single stage with a GitHub task and a Jira task. Since users can
configure multiple Jira connection, it's required to pass in a `connectionId`
for Jira task to specify which connection to use.
+Collect multiple Jenkins jobs sequentially. Below is an example for collecting
2 Jenkins jobs sequentially. It has 2 stages, each contains a Jenkins task.
```
[
- [
- {
- "Plugin": "github",
- "Options": {
- "repo": "lake",
- "owner": "merico-dev"
- }
- },
- {
- "Plugin": "jira",
- "Options": {
- "connectionId": 1,
- "boardId": 76
- }
- }
- ]
+ [
+ {
+ "plugin": "jenkins",
+ "options": {
+ "connectionId": 1,
+ "scopeId": "auto_deploy"
+ }
+ }
+ ],
+ [
+ {
+ "plugin": "jenkins",
+ "options": {
+ "connectionId": 2,
+ "scopeId": "Deploy test"
+ }
+ }
+ ]
]
```
-### 3. Zentao
-Below is an example for collecting a Zentao workspace. Since users can
configure multiple Zentao connection, it's required to pass in a `connectionId`
for Tapd task to specify which connection to use.
+- `connectionId`: The `ID` field from **Connections Jenkins** page.
+- `scopeId`: Jenkins job name.
+
+### 4. Jira
+
+Collect multiple Jira boards sequentially. Below is an example for collecting
2 Jira boards sequentially. It has 2 stages, each contains a Jira task.
```
[
- [
- {
- plugin: 'zentao',
- options: {
- connectionId: 1,
- productId: 1,
- projectId: 1,
- executionId: 1
- }
- }
- ]
+ [
+ {
+ "plugin": "jira",
+ "options": {
+ "boardId": 8,
+ "connectionId": 1
+ }
+ }
+ ],
+ [
+ {
+ "plugin": "jira",
+ "options": {
+ "boardId": 26,
+ "connectionId": 1
+ }
+ }
+ ]
]
```
-- `connectionId`: The `ID` field from **ZENTAO Integration** page.
-- `productId`: optional, ZENTAO product id, see "Find Product Id" for details.
-- `projectId`: optional, ZENTAO product id, see "Find Project Id" for details.
-- `executionId`: optional, ZENTAO product id, see "Find Execution Id" for
details.
+- `connectionId`: The `ID` field from **Connections Jira** page.
+- `boardId`: Just take a look at the URL - it will be the last number in the
address. Should look something like this at the end:
`RapidBoard.jspa?rapidView=8` or `/projects/xxx/boards/8`. So `8` would be the
board ID in that case.
-You must choose at least one of `productId`, `projectId` and `executionId`.
+### 5. Jira + GitLab
-#### Find Product Id
-1. Navigate to the Zentao Product in the browser
- 
-2. Click the red square annotated in the pic above
- 
-3. Then the number in the red circle above is `ProductId`
+Below is an example for collecting a GitLab repo and a Jira board in parallel.
It has a single stage with a GitLab task and a Jira task.
Review Comment:
It has a single stage with a GitLab task and a Jira task. As GitLab and Jira
are using their own tokens, they can be executed in parallel.
##########
docs/UserManuals/ConfigUI/AdvancedMode.md:
##########
@@ -47,92 +81,114 @@ Below is an example for collecting 2 GitLab repos
sequentially. It has 2 stages,
{
"Plugin": "gitlab",
"Options": {
- "projectId": 15238074
+ "connectionId": 1,
+ "projectId": 152***74
}
}
],
[
{
"Plugin": "gitlab",
"Options": {
- "projectId": 11624398
+ "connectionId": 2,
+ "projectId": 116***98
}
}
]
]
```
-### 2. Github
-Collect a GitHub repo and a Jira board in parallel
+### 3. Jenkins
-Below is an example for collecting a GitHub repo and a Jira board in parallel.
It has a single stage with a GitHub task and a Jira task. Since users can
configure multiple Jira connection, it's required to pass in a `connectionId`
for Jira task to specify which connection to use.
+Collect multiple Jenkins jobs sequentially. Below is an example for collecting
2 Jenkins jobs sequentially. It has 2 stages, each contains a Jenkins task.
```
[
- [
- {
- "Plugin": "github",
- "Options": {
- "repo": "lake",
- "owner": "merico-dev"
- }
- },
- {
- "Plugin": "jira",
- "Options": {
- "connectionId": 1,
- "boardId": 76
- }
- }
- ]
+ [
+ {
+ "plugin": "jenkins",
+ "options": {
+ "connectionId": 1,
+ "scopeId": "auto_deploy"
+ }
+ }
+ ],
+ [
+ {
+ "plugin": "jenkins",
+ "options": {
+ "connectionId": 2,
+ "scopeId": "Deploy test"
+ }
+ }
+ ]
]
```
-### 3. Zentao
-Below is an example for collecting a Zentao workspace. Since users can
configure multiple Zentao connection, it's required to pass in a `connectionId`
for Tapd task to specify which connection to use.
+- `connectionId`: The `ID` field from **Connections Jenkins** page.
Review Comment:
The `ID` of your Jenkins connection at page {Config-ui
URL}/connections/jenkins
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
