Crystal Ball
Crystal ball is an easy app to check if github an issue can be consider as invalid or dummy. It's also a GitHub action which simplify usage.
Problem to solve
From time to time we are expecting issues which are not actionable.
An empty issue body is an example of unactionable issue. Simillarly if an issue template with a checklist is given but no field is selected it's possible to consider an issue as not ready to be triaged.
The Crystal Ball action will check an issue description and responds to it based on predefined checks or customer provided regular expressions.
Usage
Action example
name: crystall ball
on:
issues:
types: [opened, edited]
jobs:
fortune_teller:
runs-on: ubuntu-latest
name: Fortune teller
steps:
- name: Checkout
uses: actions/checkout@v2
- name: Crystal Ball
# rm line below if you want to apply same rules for PR description
if: ${{ !github.event.issue.pull_request }}
uses: n0npax/[email protected]
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
CRYSTAL_MATCH_REGEX_BAR: 'description:?\s*\Z'
CRYSTAL_NOMATCH_REGEX_FOO: '(\w+\s+){0,10}'
# COMMENT_MSG: blah blah blah
with:
repoName: ${{ github.repository }}
issueNum: ${{ github.event.issue.number }}
labels: "invalid,crystall ball needed"
ENV variables
Default comment message can be changed by:
COMMENT_MSG: "comment message (above failure reason)
Multiple regular expressions can be used to validate an issue body. Any ENV variable starting with CRYSTAL_{NO,}MATCH_REGEX will be used. If match does/doesn't exists, the issue is considered as invalid and crystal ball will comment it.
CRYSTAL_NOMATCH_REGEX_FOO: '^foo$'
CRYSTAL_MATCH_REGEX_BAR: 'bar{4}'
Github token is required to perform actions.
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
Example
How the action may look like:
Live demo
Just raise an issue with an empty body here.
LICENSE
Code under the MIT license.
![Flutter's [FlatList] widget for React Native friendly developers](https://user-images.githubusercontent.com/27461460/201466389-a74baf6a-c12d-4558-a2e8-750884ccfd9f.gif)
![[Snyk] Security upgrade debian from bullseye-slim to 11-slim](https://avatars.githubusercontent.com/u/19733683?v=4)
| 500 | Use After Free 
| 371 | NULL Pointer Dereference 
| 567 | Out-of-bounds Read 
18 Apr 14, 2022
45 Dec 29, 2022
0 Oct 25, 2021
112 Nov 11, 2022
2 Dec 2, 2021
94 Dec 7, 2022
30 Dec 31, 2022
3 Feb 1, 2021
401 Jan 4, 2023
3 Sep 13, 2022