Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(linker): add linker plugin #756

Merged
merged 4 commits into from
May 28, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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)
Loading