https://github.com/nhatthm/gherkin-lint-action

GitHub action for gherkin-lint
https://github.com/nhatthm/gherkin-lint-action

action bdd continuous-integration cucumber gherkin gherkin-lint github github-action github-actions lint linter test-integration

Last synced: 2 months ago
JSON representation

GitHub action for gherkin-lint

• Host: GitHub
• URL: https://github.com/nhatthm/gherkin-lint-action
• Owner: nhatthm
• License: mit
• Created: 2021-11-30T22:11:10.000Z (about 3 years ago)
• Default Branch: master
• Last Pushed: 2023-09-06T08:10:53.000Z (over 1 year ago)
• Last Synced: 2024-10-04T21:46:22.168Z (3 months ago)
• Topics: action, bdd, continuous-integration, cucumber, gherkin, gherkin-lint, github, github-action, github-actions, lint, linter, test-integration
• Language: Shell
• Homepage: https://github.com/marketplace/actions/run-gherkin-lint
• Size: 8.79 KB
• Stars: 3
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# gherkin-lint-action

A GitHub Action to parse feature files and run linting against the default rules, and the optional rules you specified in your `.gherkin-lintrc` file.

## Usage

Add `.github/workflows/lint.yml` with the following contents:

```yaml

name: lint

on:

  push:

    tags:

      - v*

    branches:

      - master

      - main

  pull_request:

jobs:

  lint:

    runs-on: ubuntu-latest

    steps:

      - uses: actions/checkout@v2

      - name: gherkin-lint

        uses: nhatthm/gherkin-lint-action@v1

        with:

          # Optional: Version of gherkin-lint to use in the `npm install -g gherkin-lint` command. Default to `latest`.

          # version: latest

          # Optional: Comma separated list of feature files/glob patterns. Default to current working directory.

          feature_files: features/*

          # Optional: Use a custom configuration file instead of the default one.

          # config_file: .gherkin-lintrc

          # Optional: Output format. Possible values: json, stylish, xunit. Default to `stylish`.

          # format: stylish

          # Optional: Comma seperated list of files/glob patterns that the linter should ignore, overrides .gherkin-lintignore file

          # ignore:

          # Optional: Comma seperated list of additional rule directories

          # rule_dirs:

```

To specify some rule you can add a configuration file `.gherkin-lintrc` into your project folder.

If you don't specify anything, the [default ruleset](.gherkin-lintrc) is used.

See the [list of available rules](https://github.com/vsiakka/gherkin-lint#available-rules).

## Donation

If this project help you reduce time to develop, you can give me a cup of coffee :)

### Paypal donation

[![paypal](https://www.paypalobjects.com/en_US/i/btn/btn_donateCC_LG.gif)](https://www.paypal.com/donate/?hosted_button_id=PJZSGJN57TDJY)

       or scan this