Skip to content

Repository files navigation

echo

Release

Reusable GitHub Action for suggesting potentially similar issues and upserting a triage comment.

It is designed for issue opened, edited, or reopened events, and it works by:

  • fetching a recent set of issues from the target repository
  • scoring overlap from issue titles and bodies
  • grouping likely matches into open and closed sections
  • posting or updating a single bot comment marked with a hidden marker

Requirements

  • GitHub Actions runner with gh, jq, and python3
  • issues: write permission
  • contents: read permission

Example

name: Suggest Similar Issueson:
issues:
types: [opened, reopened, edited]jobs:
suggest-similar:
runs-on: ubuntu-latestpermissions:
contents: readissues: writesteps:
- uses: actions/checkout@v4
- uses: libnudget/echo@mainwith:
github_token: ${{ secrets.GITHUB_TOKEN }}repository: ${{ github.repository }}issue_number: ${{ github.event.issue.number }}issue_title: ${{ github.event.issue.title }}issue_body: ${{ github.event.issue.body }}

Inputs

NameRequiredDefaultNotes
github_tokenyesToken with issue write access
repositoryyesowner/name repository
issue_numberyesCurrent issue number
issue_titleyesCurrent issue title
issue_bodyno""Current issue body
issue_limitno100How many issues to fetch
result_limitno10How many scored matches to keep
visible_per_stateno3How many open or closed lines to show
markerno<!-- issue-similarity-check -->Hidden marker for comment updates
intro_textnostandard textComment intro
outro_textnostandard textComment outro
footer_textno@libnudgetFooter mention or link
stopwords_regexnobuilt-in regexWords ignored during scoring

Notes

  • The action only comments when it has at least one visible match line.
  • Existing bot comments with the same marker are updated instead of duplicated.
  • The scoring is intentionally lightweight and heuristic-based.

License

MIT

About

Suggests related issues.

Topics

Resources

Contributing

Security policy

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages