Skip to content
navigation

GitHub Action

Issues Similarity Analysis

v1.3.2 Latest version

Issues Similarity Analysis

navigation

Issues Similarity Analysis

A GitHub Action help you analysis similarity based on the title of issue

Installation

Copy and paste the following snippet into your .yml file.

              

- name: Issues Similarity Analysis

uses: actions-cool/[email protected]

Learn more about this action in actions-cool/issues-similarity-analysis

Choose a version

πŸ‘ Issues Similarity Analysis

A GitHub Action help you analysis similarity based on the title of issue.

πŸ‘‹ Preview

πŸš€ How to use?

name: Issues Similarity Analysis

on:
  issues:
    types: [opened, edited]

jobs:
  similarity-analysis:
    runs-on: ubuntu-latest
    steps:
      - name: analysis
        uses: actions-cool/issues-similarity-analysis@v1
        with:
          filter-threshold: 0.5
          title-excludes: 'bug, not, 1234'
          comment-title: '### See'
          comment-body: '${index}. ${similarity} #${number}'
Name Desc Type Default Required
token GitHub token. string GitHub Bot Token βœ–
since-days How days to query the issues that updated since. number 100 βœ–
filter-threshold Filter issues similarity higher than this threshold. number 0.8 βœ–
title-excludes Exclude words before filter. string - βœ–
comment-title Comment title customization. string ### Issues Similarity Analysis: βœ–
comment-body Comment body customization. string - [#${number}][${title}][${similarity}] βœ–
show-footer Whether show footer. boolean true βœ–
show-mentioned Whether show mentioned issues in the current issue body boolean false βœ–
  • filter-threshold: Keep in [0, 1]
  • comment-body:
    • The filter issues sort by threshold desc
    • Support ${index} ${number} ${title} ${similarity}

The return format is as follows:

  "similar-issues": [
    { "number": 6, "title": "bug 2", "similarity": 1 },
    { "number": 10, "title": "bug", "similarity": 0.85 },
    { "number": 8, "title": "bug", "similarity": 0.85 }
  ],
  "similar-issues-found": "true",
  "similar-issues-number": "6,10,8"
  • Return similar-issues-found, due to yml reasons, the judgment condition is if: steps.step-id.outputs.similar-issues-found =='true'

⚑ Feedback

You are very welcome to try it out and put forward your comments. You can use the following methods:

  • Report bugs or consult with Issue
  • Submit Pull Request to improve the code of issues-similarity-analysis

也欒迎加ε…₯ 钉钉亀桁羀

Changelog

CHANGELOG

LICENSE

MIT