Skip to content

Commit 6936d0a

Browse files
Merge pull request #15 from aws-github-ops/tests
(tests): Covered 80% of lines
2 parents 6d6def1 + d93faa9 commit 6936d0a

File tree

7 files changed

+8490
-579
lines changed

7 files changed

+8490
-579
lines changed

.github/workflows/unit-test.yml

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
name: Unit Test
2+
3+
on: push
4+
5+
jobs:
6+
jest-tests:
7+
name: Jest tests
8+
runs-on: ubuntu-latest
9+
steps:
10+
- uses: actions/checkout@v2
11+
12+
- name: Install dependencies
13+
run: npm install
14+
15+
- name: Testing
16+
run: npm run test

README.md

Lines changed: 26 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,10 +17,34 @@ The value of words in the body of the issue are worth a constant value which can
1717

1818
Keywords don't have to be an _exact_ match for the word to count. You can allow for slight amount of user error by tuning the `similarity` input. A value of 0 means that keywords have to be an exact match
1919

20+
## Quick Start
21+
22+
1. Install dependencies with NPM
23+
24+
```sh
25+
npm install
26+
```
27+
28+
2. Build the JS files
29+
30+
```sh
31+
npm run build
32+
```
33+
34+
## Tests
35+
36+
Run all unit tests using Jest.
37+
38+
```sh
39+
npm run test
40+
```
41+
42+
_Append `-- --watch` to auto run tests when changes are saved._
43+
2044
## Inputs
2145

2246
### parameters
23-
Parameters should take the form
47+
Parameters should take the form
2448
```json
2549
[
2650
{
@@ -34,7 +58,7 @@ Parameters should take the form
3458

3559
### default-area
3660
If no keywords are detected in your issue, set these default labels and assignees
37-
```
61+
```json
3862
{
3963
"labels": ["labels"],
4064
"assignees": ["assignees"]

0 commit comments

Comments
 (0)