https://github.com/fabasoad/nsfw-detection-action
This GitHub action detects NSFW content in a commited files.
https://github.com/fabasoad/nsfw-detection-action
github-action github-actions nsfw-detection nsfw-recognition
Last synced: 29 days ago
JSON representation
This GitHub action detects NSFW content in a commited files.
- Host: GitHub
- URL: https://github.com/fabasoad/nsfw-detection-action
- Owner: fabasoad
- License: mit
- Created: 2020-03-16T13:11:16.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2025-03-11T22:03:36.000Z (about 1 month ago)
- Last Synced: 2025-03-11T23:19:14.814Z (about 1 month ago)
- Topics: github-action, github-actions, nsfw-detection, nsfw-recognition
- Language: Shell
- Homepage:
- Size: 12.6 MB
- Stars: 17
- Watchers: 1
- Forks: 4
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- awesome-actions - NSFW Detection - Detect NSFW content in committed files. (Community Resources / Utility)
- fucking-awesome-actions - NSFW Detection - Detect NSFW content in committed files. (Community Resources / Utility)
- awesome-workflows - NSFW Detection - Detect NSFW content in committed files. (Community Resources / Utility)
README
# NSFW detection action
[](https://stand-with-ukraine.pp.ua)
This action checks each modified and added file with the extensions that is defined
in action configuration and failed in case of threshold of NSFW check is greater
or equals to the threshold defined in action configuration. NSFW detection runs
by chosen provider.
## Contents
* [NSFW detection action](#nsfw-detection-action)
* [Contents](#contents)
* [Providers](#providers)
* [Cloudmersive](#cloudmersive)
* [PicPurify](#picpurify)
* [SightEngine](#sightengine)
* [Supported OS](#supported-os)
* [Prerequisites](#prerequisites)
* [Inputs](#inputs)
* [Outputs](#outputs)
## Providers
### Cloudmersive
Identifier is `cloudmersive`. Sign up to [Cloudmersive](https://cloudmersive.com/)
official website. Then go to [API Keys](https://account.cloudmersive.com/keys)
page, create a new one and copy it.
### PicPurify
Identifier is `picpurify`. Sign up to [PicPurify](https://www.picpurify.com/)
official website. Then go to [API Keys](https://www.picpurify.com/apikey.html)
page and copy `API key` that is located on the top of the page.
### SightEngine
Identifier is `sightengine`. Sign up to [SightEngine](https://sightengine.com/)
official website. Then go to [Get Started](https://dashboard.sightengine.com/getstarted)
page and copy API user and API secret from the examples provided. This provider
requires to provide 2 API identifiers, so please put them into `api-key` parameter
separated by comma. For example, `api-key` should be _123456,abcdef_ if your
`api_user` is _123456_ and `api_secret` is _abcdef_.
## Supported OS
| OS | |
|---------|--------------------|
| Windows | :white_check_mark: |
| Linux | :white_check_mark: |
| macOS | :white_check_mark: |
## Prerequisites
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).
## Inputs
```yaml
- 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"
```
## Outputs
None.