customize action

willcaul · Feb 17, 2021 · 1a6e899 · 1a6e899
1 parent bcc66d5
commit 1a6e899
Show file tree

Hide file tree

Showing 13 changed files with 274 additions and 280 deletions.
diff --git a/README.md b/README.md
@@ -7,18 +7,20 @@ Main features:
 
 ## Coverage example
 
-![Coverage](assets/coverage.png)
+![Coverage Summary](assets/coverage-summary.png)
+
+![Coverage Details](assets/coverage-details.png)
 
 ## Check annotations example
 
-![Fail](assets/fail.png)
+![Test Failure](assets/annotation.png)
 
 ## Usage
 
 You can now consume the action by referencing the v1 branch
 
 ```yaml
-uses: mattallty/jest-github-action@v1
+uses: willcaul/jest-github-action@v1
 env:
   GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 ```
@@ -29,7 +31,7 @@ By default, this action will execute `npm test` to run your tests.
 You can change this behavior by providing a custom `test-command` like this:
 
 ```yaml
-uses: mattallty/jest-github-action@v1
+uses: willcaul/jest-github-action@v1
 env:
   GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 with:
@@ -40,7 +42,7 @@ with:
 ### Running tests only on changed files
 
 ```yaml
-uses: mattallty/jest-github-action@v1
+uses: willcaul/jest-github-action@v1
 env:
   GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 with:
@@ -52,7 +54,7 @@ with:
 ### Silencing the code coverage comment
 
 ```yaml
-uses: mattallty/jest-github-action@v1
+uses: willcaul/jest-github-action@v1
 env:
   GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 with:
@@ -65,12 +67,14 @@ with:
 For running tests in folders other than root, supply a working-directory.
 
 ```yaml
-uses: mattallty/jest-github-action@v1
+uses: willcaul/jest-github-action@v1
 env:
   GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 with:
   working-directory: "frontend"
 ```
 
 
-See the [actions tab](https://github.com/mattallty/jest-github-action/actions) for runs of this action! :rocket:
+## Credits
+
+Thanks to [mattallty/jest-github-action](https://github.com/mattallty/jest-github-action), which this package is forked from, as well as [FirmNav/jest-code-coverage-commenter](https://github.com/FirmNav/jest-code-coverage-commenter), which was used as a reference for the coverage comment format.
diff --git a/action.yml b/action.yml
@@ -1,8 +1,8 @@
-name: "Jest Annotations & Coverage"
+name: "Jest GitHub Action"
 description: "Jest action adding checks and annotations to your pull requests and comment them with code coverage results."
 branding:
   icon: "check"
-  color: "blue"
+  color: "green"
 inputs:
   test-command:
     description: "The test command to run"

diff --git a/assets/annotation.png b/assets/annotation.png
diff --git a/assets/coverage-details.png b/assets/coverage-details.png
diff --git a/assets/coverage-summary.png b/assets/coverage-summary.png
diff --git a/assets/coverage.png b/assets/coverage.png
diff --git a/assets/fail.png b/assets/fail.png
diff --git a/dist/index.js b/dist/index.js