mirror of
https://github.com/iv-org/close-potential-duplicates.git
synced 2024-11-23 05:49:44 +00:00
46 lines
1.7 KiB
Markdown
46 lines
1.7 KiB
Markdown
# Potential Duplicates
|
||
|
||
> A Github Action to search for potential issue duplicates using [Damerau–Levenshtein](https://en.wikipedia.org/wiki/Damerau%E2%80%93Levenshtein_distance) algorithm.
|
||
|
||
## Usage
|
||
|
||
Create `.github/workflows/potential-duplicates.yml` in the default branch:
|
||
|
||
```yaml
|
||
name: Potential Duplicates
|
||
on:
|
||
issues:
|
||
types: [opened, edited]
|
||
jobs:
|
||
run:
|
||
runs-on: ubuntu-latest
|
||
steps:
|
||
- uses: bubkoo/potential-duplicates@v1
|
||
with:
|
||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||
# Issue title filter work with anymatch https://www.npmjs.com/package/anymatch.
|
||
# Any matched issue will stop detection immediately.
|
||
# You can specify multi filters in each line.
|
||
filter: ''
|
||
# Exclude keyworlds in title before detecting.
|
||
exclude: ''
|
||
# Label to set, when potential duplicates are detected.
|
||
label: potential-duplicate
|
||
# Get issues with state to compare. Supported state: 'all', 'closed', 'open'.
|
||
state: all
|
||
# If similarity is higher than this threshold([0,1]), issue will be marked as duplicate.
|
||
threshold: 0.6
|
||
# Reactions to be add to comment when potential duplicates are detected.
|
||
# Available reactions: "-1", "+1", "confused", "laugh", "heart", "hooray", "rocket", "eyes"
|
||
reactions: 'eyes, confused'
|
||
# Comment to post when potential duplicates are detected.
|
||
comment: >
|
||
Potential duplicates: {{#issues}}
|
||
- [#{{ number }}] {{ title }} ({{ accuracy }}%)
|
||
{{/issues}}
|
||
```
|
||
|
||
## License
|
||
|
||
The scripts and documentation in this project are released under the [MIT License](LICENSE)
|