Skip to content

Commit

Permalink
docs(linker): add linker plugin (#756)
Browse files Browse the repository at this point in the history
* docs(linker): add linker plugin

* docs(linker): update docs

* docs(linker): update docs

* docs(linker): add to version 1.0
  • Loading branch information
d4x1 authored May 28, 2024
1 parent d5903ab commit a9aa707
Show file tree
Hide file tree
Showing 3 changed files with 42 additions and 0 deletions.
21 changes: 21 additions & 0 deletions docs/Plugins/linker.md
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)
Binary file added static/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.
21 changes: 21 additions & 0 deletions versioned_docs/version-v1.0/Plugins/linker.md
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)

0 comments on commit a9aa707

Please sign in to comment.