iv-org/close-potential-duplicates
1
0
Fork 0
mirror of https://github.com/iv-org/close-potential-duplicates.git synced 2024-11-26 23:50:43 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
🔎 Search for potential issue duplicates using Damerau–Levenshtein algorithm and close them
29 Commits 1 Branch 3 Tags 278 KiB
TypeScript 97.5%
Shell 2.5%
cc63d6d273
Go to file
bubkoo cc63d6d273 ci: 👷 release
2021-09-26 15:50:39 +08:00
.github/workflows ci: 👷 release 2021-09-26 15:50:39 +08:00
.husky chore: 🛠️ git hooks 2021-09-21 11:00:45 +08:00
src refactor: ♻️ update deps 2021-09-21 11:01:01 +08:00
.editorconfig perf: ⚡️ init 2020-09-27 21:29:47 +08:00
.eslintrc ci: 👷 tslint => eslint 2021-09-21 11:00:27 +08:00
.gitignore perf: ⚡️ init 2020-09-27 21:29:47 +08:00
.prettierignore perf: ⚡️ init 2020-09-27 21:29:47 +08:00
.prettierrc perf: ⚡️ init 2020-09-27 21:29:47 +08:00
action.yml fix: 🐛 typos 2021-01-22 09:14:37 +08:00
LICENSE Initial commit 2020-09-27 14:16:24 +08:00
package.json refactor: ♻️ update deps 2021-09-21 11:01:01 +08:00
README.md refactor: ♻️ update deps 2021-09-21 11:01:01 +08:00
tsconfig.json perf: ⚡️ init 2020-09-27 21:29:47 +08:00
yarn.lock refactor: ♻️ update deps 2021-09-21 11:01:01 +08:00

README.md

Potential Duplicates

Search for potential issue duplicates using Damerau–Levenshtein algorithm

Usage

Create .github/workflows/potential-duplicates.yml in the default branch:

name: Potential Duplicates
on:
  issues:
    types: [opened, edited]
jobs:
  run:
    runs-on: ubuntu-latest
    steps:
      - uses: wow-actions/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 keywords 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}}

Inputs

Various inputs are defined to let you configure the action:

Note: Workflow command and parameter names are not case-sensitive.

Name Description Default
GITHUB_TOKEN The GitHub token for authentication N/A
filter Issue title filter work with anymatch
Any matched issue will stop detection immediately
You can specify multi filters in each line		 ''
exclude Exclude keywords in title before detecting ''
label Label to set, when potential duplicates are detected 'potential-duplicate'
state Get issues with state to compare. Supported state: 'all' 'closed' 'open' 'all'
threshold If similarity is higher than this threshold([0,1]), issue will be marked as duplicate 0.6
reactions Reactions to be add to comment when potential duplicates are detected
Available reactions: "-1", "+1", "confused", "laugh", "heart", "hooray", "rocket", "eyes"
comment Comment to post when potential duplicates are detected 👇

Available reactions:

content emoji
+1 👍
-1 👎
laugh 😄
confused 😕
heart ❤️
hooray 🎉
rocket 🚀
eyes 👀

Default comment:

Potential duplicates: {{#issues}}
  - [#{{ number }}] {{ title }} ({{ accuracy }}%)
{{/issues}}

License

The scripts and documentation in this project are released under the MIT License