-
Notifications
You must be signed in to change notification settings - Fork 98
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs(linker): add linker plugin (#756)
* docs(linker): add linker plugin * docs(linker): update docs * docs(linker): update docs * docs(linker): add to version 1.0
- Loading branch information
Showing
3 changed files
with
42 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
--- | ||
title: "Linker" | ||
description: > | ||
Linker Plugin | ||
--- | ||
|
||
This document comprehensively explains Linker and provides guidance on implementing this powerful and practical framework in DevLake. | ||
|
||
## Summary | ||
|
||
Just like the DORA plugin, the linker works on the domain layer and attempts to link the domain layer data. | ||
|
||
For example, in the current version, the linker uses regular expressions to extract issue_keys from pull requests' title and description fields, and it tries to relate existing issues with PRs, storing the relations in the `pull_request_issues` table. | ||
|
||
|
||
## Supported Versions | ||
The linker was added in release v1.0.0-beta10 and has been available ever since. | ||
|
||
## Configuration | ||
You can find it on the project settings page. | ||
![](/img/Plugins/linker-configuration.png) |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
--- | ||
title: "Linker" | ||
description: > | ||
Linker Plugin | ||
--- | ||
|
||
This document comprehensively explains Linker and provides guidance on implementing this powerful and practical framework in DevLake. | ||
|
||
## Summary | ||
|
||
Just like the DORA plugin, the linker works on the domain layer and attempts to link the domain layer data. | ||
|
||
For example, in the current version, the linker uses regular expressions to extract issue_keys from pull requests' title and description fields, and it tries to relate existing issues with PRs, storing the relations in the `pull_request_issues` table. | ||
|
||
|
||
## Supported Versions | ||
The linker was added in release v1.0.0-beta10 and has been available ever since. | ||
|
||
## Configuration | ||
You can find it on the project settings page. | ||
![](/img/Plugins/linker-configuration.png) |