docs: github action improvements

Author: vladopajic

docs/github_action.md

@@ -1,7 +1,7 @@
 # go-test-coverage GitHub Action
 
 
-# Usage
+## Usage
 
 Here’s an example of how to integrate `go-test-coverage` in a GitHub workflow that uses a config file. This is the preferred way because the same config file can be used for running coverage checks locally.
 
@@ -27,7 +27,7 @@ Alternatively, if you don't need advanced configuration options from a config fi
 
 Note: When using a config file alongside action properties, specifying these parameters will override the corresponding values in the config file.
 
-# Action Outputs
+## Action Outputs
 
 The GitHub Action will set the following outputs, which can be used later in your workflow:
 
@@ -40,7 +40,22 @@ The GitHub Action will set the following outputs, which can be used later in you
 
 Note: Action outputs and inputs are also documented in [action.yml](/action.yml) file.
 
-# Post Coverage Report to PR
+## Liberal Coverage Check
+
+The `go-test-coverage` GitHub Action can be configured to report the current test coverage without enforcing specific thresholds. To enable this functionality in your GitHub workflow, include the `continue-on-error: true` property in the job step configuration. This ensures that the workflow proceeds even if the coverage check fails.
+
+Below is an example that reports files with coverage below 80% without causing the workflow to fail:
+```yml
+  - name: check test coverage
+    id: coverage
+    uses: vladopajic/go-test-coverage@v2
+    continue-on-error: true
+    with:
+      profile: cover.out
+      threshold-file: 80
+```
+
+## Post Coverage Report to PR
 
 Here is an example of how to post comments with the coverage report to your pull request. The same logic is used in workflow in [this repo](/.github/workflows/test.yml).
 
@@ -50,7 +65,7 @@ Here is an example of how to post comments with the coverage report to your pull
     uses: vladopajic/go-test-coverage@v2
     continue-on-error: true # Should fail after coverage comment is posted
     with:
-        config: ./.github/.testcoverage.yml
+      config: ./.github/.testcoverage.yml
     
     # Post coverage report as comment (in 3 steps)
   - name: find pull request ID
@@ -69,25 +84,29 @@ Here is an example of how to post comments with the coverage report to your pull
     uses: peter-evans/find-comment@v3
     id: fc
     with:
-        issue-number: ${{ env.pull_request_id }}
-        comment-author: 'github-actions[bot]'
-        body-includes: 'go-test-coverage report:'
+      issue-number: ${{ env.pull_request_id }}
+      comment-author: 'github-actions[bot]'
+      body-includes: 'go-test-coverage report:'
   - name: post coverage report
     if: env.pull_request_id
     uses: peter-evans/create-or-update-comment@v4
     with:
-        token: ${{ secrets.GITHUB_TOKEN }}
-        issue-number: ${{ env.pull_request_id }}
-        comment-id: ${{ steps.fc.outputs.comment-id }}
-        body: |
+      token: ${{ secrets.GITHUB_TOKEN }}
+      issue-number: ${{ env.pull_request_id }}
+      comment-id: ${{ steps.fc.outputs.comment-id }}
+      body: |
         go-test-coverage report:
         ```
         ${{ fromJSON(steps.coverage.outputs.report) }} 
         ```
-        edit-mode: replace
+      edit-mode: replace
 
   - name: "finally check coverage"
     if: steps.coverage.outcome == 'failure'
     shell: bash
     run: echo "coverage check failed" && exit 1
-```          
+```
+
+## Generate Coverage Badge
+
+Instructions for badge creation are available [here](./badge.md).