https://github.com/restqa/gherkin-linter-action

🧹 | A Github Action to parse and validate your Gherkin feature files
https://github.com/restqa/gherkin-linter-action

bdd cucumber e2e gherkin gherkin-lint linter restqa test-automation testing

Last synced: 3 months ago
JSON representation

🧹 | A Github Action to parse and validate your Gherkin feature files

• Host: GitHub
• URL: https://github.com/restqa/gherkin-linter-action
• Owner: restqa
• Created: 2020-05-02T15:16:20.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2022-03-22T14:55:31.000Z (almost 3 years ago)
• Last Synced: 2024-03-15T02:31:32.310Z (11 months ago)
• Topics: bdd, cucumber, e2e, gherkin, gherkin-lint, linter, restqa, test-automation, testing
• Language: Dockerfile
• Homepage:
• Size: 7.81 KB
• Stars: 3
• Watchers: 2
• Forks: 3
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# gherkin-linter-action

> A Github Action to parse and validate your feature files (gherkin / cucumber)

## Usage

Based on the [gherkin-lint library](https://www.npmjs.com/package/gherkin-lint) this action validate your feature files.

Since the feature files can be edited by any team member a linter is the minimum check you should add before running your test suites

If all your feature files are in a folder called `tests`, run it like this:

```yaml

name: E2E Test

on: [push]

jobs:

  Gherkin-lint:

    runs-on: ubuntu-latest

    steps:

    - uses: actions/checkout@v1

    - uses: restqa/[email protected]

      with:

        path: 'test/'

        config_file: 'test/.gherkin-lintrc'

```

To specify some rule you can add the configuration file `.gherkin-lintrc` into your root folder. (see rules on the [gherkin-lint](https://www.npmjs.com/package/gherkin-lint#configuration-file) library)

### Do you know RestQa ? 

Restqa is an open automation framework based on Gherkin.

A few step and your Test automation framework is setup. No dependency the framework is ready to be plug to all your project components

[Give a try](https://github.com/restqa) 🚀

### References

* [Gherkin-lint](https://www.npmjs.com/package/gherkin-lint)

* [RestQa](https://www.restqa.io)

* [RestQa Organization](https://github.com/restqa)

### Keywords

* test automation

* Gherkin

* Cucumber

* End to End

* E2E

* Quality assurance

* QA

* Continuous integration

* RestQa