Debug 18

fabasoad · Jan 3, 2025 · 60c769c · 60c769c
1 parent e39ff5e
commit 60c769c
Show file tree

Hide file tree

Showing 9 changed files with 42 additions and 64 deletions.
diff --git a/.github/workflows/functional-tests.yml b/.github/workflows/functional-tests.yml
@@ -26,14 +26,14 @@ jobs:
         include:
           - provider: cloudmersive
             api-key: CLOUDMERSIVE_API_KEY
-            threshold: 0.32
+            threshold: 0.45
           - provider: picpurify
             api-key: PICPURIFY_API_KEY
-            threshold: 0.97
+            threshold: 0.95
           - provider: sightengine
             api-user: SIGHTENGINE_API_USER
             api-key: SIGHTENGINE_API_SECRET
-            threshold: 0.8
+            threshold: 0.85
     steps:
       - name: Checkout ${{ github.repository }}
         uses: actions/checkout@v4

diff --git a/.github/workflows/linting.yml b/.github/workflows/linting.yml
@@ -8,11 +8,6 @@ on: # yamllint disable-line rule:truthy
       - main
 
 jobs:
-  js-lint:
-    name: JS Lint
-    uses: fabasoad/reusable-workflows/.github/workflows/wf-js-lint.yml@main
   pre-commit:
     name: Pre-commit
     uses: fabasoad/reusable-workflows/.github/workflows/wf-pre-commit.yml@main
-    with:
-      skip-hooks: "audit, build, lint, test"
diff --git a/.github/workflows/unit-tests.yml b/.github/workflows/unit-tests.yml
diff --git a/91cDPlxcRiL._SL1500_.jpg b/91cDPlxcRiL._SL1500_.jpg
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -45,8 +45,8 @@ use them to create an issue and fill all required fields.
 
 ## Use a consistent coding style
 
-Please follow all the rules from [this](https://github.com/excelmicro/typescript)
-great guide provided by [excelmicro](https://github.com/excelmicro) for coding style.
+Please follow all the rules from [this](https://google.github.io/styleguide/shellguide.html)
+great guide provided by Google for coding style.
 
 ## License
 

diff --git a/README.md b/README.md
@@ -17,18 +17,20 @@ by chosen provider.
 
 ## Contents
 
+<!-- prettier-ignore-start -->
 <!-- TOC -->
 * [NSFW detection action](#nsfw-detection-action)
   * [Contents](#contents)
   * [Providers](#providers)
     * [Cloudmersive](#cloudmersive)
     * [PicPurify](#picpurify)
     * [SightEngine](#sightengine)
+  * [Supported OS](#supported-os)
+  * [Prerequisites](#prerequisites)
   * [Inputs](#inputs)
-  * [Example usage](#example-usage)
-    * [Workflow configuration](#workflow-configuration)
-    * [Result](#result)
+  * [Outputs](#outputs)
 <!-- TOC -->
+<!-- prettier-ignore-end -->
 
 ## Providers
 
@@ -53,42 +55,41 @@ requires to provide 2 API identifiers, so please put them into `api-key` paramet
 separated by comma. For example, `api-key` should be _123456,abcdef_ if your
 `api_user` is _123456_ and `api_secret` is _abcdef_.
 
-## Inputs
+## Supported OS
+
+<!-- prettier-ignore-start -->
+| OS      |                    |
+|---------|--------------------|
+| Windows | :white_check_mark: |
+| Linux   | :white_check_mark: |
+| macOS   | :white_check_mark: |
+<!-- prettier-ignore-end -->
 
-| Name         | Required | Description                                                                                   | Default                          | Possible values                  |
-|--------------|----------|-----------------------------------------------------------------------------------------------|----------------------------------|----------------------------------|
-| github-token | Yes      | GitHub token                                                                                  |                                  | &lt;String&gt;                   |
-| provider     | Yes      | Provider identifier                                                                           |                                  | &lt;String&gt;                   |
-| api-key      | Yes      | API key that should be used for chosen `provider`                                             |                                  | &lt;String&gt;                   |
-| threshold    | Yes      | Action will be failed in case NSFW detection value will be greater or equal to this parameter |                                  | &lt;Float&gt;                    |
-| type         | No       | Type of committed files separated by comma                                                    | `modified,added,renamed`         | `modified,added,renamed`         |
-| extensions   | No       | List of file extensions separated by comma                                                    | `jpeg,jpg,png,gif,webp,tiff,bmp` | `jpeg,jpg,png,gif,webp,tiff,bmp` |
+## Prerequisites
 
-## Example usage
+The following tools have to be installed for successful work of this GitHub Action:
+[curl](https://curl.se), [awk](https://en.wikipedia.org/wiki/AWK).
 
-### Workflow configuration
+## Inputs
 
 ```yaml
-name: Test
-
-on: push
-
-jobs:
-  nsfw-detection:
-    name: Verify files
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-      - uses: fabasoad/nsfw-detection-action@v3
-        with:
-          provider: picpurify
-          threshold: 0.9
-          type: modified,added,renamed
-          extensions: jpg,jpeg
-          github-token: ${{ github.token }}
-          api-key: ${{ secrets.PICPURIFY_API_KEY }}
+- uses: fabasoad/nsfw-detection-action@v3
+  with:
+    # (Required) Provider identifier.
+    provider: "picpurify"
+    # (Required) API key required for the selected provider.
+    api-key: ${{ secrets.PICPURIFY_API_KEY }}
+    # (Required) The action will fail if the NSFW detection value is greater
+    # than or equal to this parameter.
+    threshold: "0.6"
+    # (Optional) Comma-separated list of file extensions for NSFW detection.
+    # Defaults to "jpeg,jpg,png,gif,webp,tiff,bmp".
+    extensions: "jpg,png,gif"
+    # (Optional) Comma-separated types of changes made during work on the branch.
+    # Defaults to "added,copied,modified,renamed".
+    types: "added,modified"
 ```
 
-### Result
+## Outputs
 
-![Result](screenshot1.png)
+None.
diff --git a/action.yml b/action.yml
@@ -65,6 +65,7 @@ runs:
         INPUT_API_KEY: ${{ inputs.api-key }}
         INPUT_THRESHOLD: ${{ inputs.threshold }}
       run: |
+        # TODO: Not all files but based on types
         ${GITHUB_ACTION_PATH}/src/providers/${INPUT_PROVIDER}.sh \
           "${{ steps.changed-files.outputs.all_changed_files }}" \
           "${INPUT_API_KEY}" \

diff --git a/screenshot1.png b/screenshot1.png
diff --git a/src/compare-with-threshold.sh b/src/compare-with-threshold.sh
@@ -5,7 +5,7 @@ compare_with_threshold() {
   threshold="${2}"
   file_path="${3}"
 
-  if awk -v t="${threshold}" -v s="${score}" 'BEGIN {exit !((t - s) < 0)}'; then
+  if awk -v t="${threshold}" -v s="${score}" 'BEGIN {exit !((t - s) <= 0)}'; then
     log_error "NSFW content detected in ${file_path} with score ${score}."
     exit 1
   elif awk -v t="${threshold}" -v s="${score}" 'BEGIN {exit !((t - s) > 0.2)}'; then