https://github.com/ken-matsui/misleading-name-check

GitHub Actions that checks whether a provided name is misleading or not
https://github.com/ken-matsui/misleading-name-check

Last synced: about 1 month ago
JSON representation

GitHub Actions that checks whether a provided name is misleading or not

• Host: GitHub
• URL: https://github.com/ken-matsui/misleading-name-check
• Owner: ken-matsui
• License: mit
• Created: 2022-02-01T16:57:52.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2022-02-02T16:20:14.000Z (almost 3 years ago)
• Last Synced: 2024-05-02T04:41:16.406Z (8 months ago)
• Homepage:
• Size: 19.5 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# misleading-name-check

GitHub Actions that checks whether a provided name is misleading or not.

## Usage

You can check whether `name` is misleading or not by comparing it with strings in `list`.

This action will output `is-misleading` so that you can extract the result afterward.

### Example workflow

```yaml

name: Misleading Name Check

on:

  push:

    branches: [ main ]

  pull_request:

    branches: [ main ]

jobs:

  misleading:

    runs-on: ubuntu-latest

    steps:

      - id: check-misleading

        uses: ken-matsui/misleading-name-check@v1

        with:

          name: aaaa

          list: aaab aaabc

      - name: Test the result

        run: |

          [ '${{ steps.check-misleading.outputs.is-misleading }}' = 'true' ]

```

### Inputs

* `name` (required): A name to check

* `list` (required): A list of words

* `version`: A version of [`suggestion-cli`](https://github.com/ken-matsui/suggestion) (default is `latest`)

* `distance`: Levenshtein distance if needed (default is `1`)

### Outputs

* `is-misleading`: A string output, either `true` or `false`.

## Contribution

Contributions, including issues and pull requests, are very welcome.