This repo aims to make it easier for users to run the inclusivelint project as part of your github action pipeline. It follows the official Github guidance to create a Docker action that can be found here.

To use it as part of you github pipeline, you can follow the example we have as the action for this repository, which is explained below:

on: [push]

jobs:
  hello_world_job:
    runs-on: ubuntu-latest
    name: Action testing job
    steps:
      - name: Checkout
        uses: actions/checkout@v2
      
      - name: Run inclusivelint
        uses: ./
        id: inclusivelint

The yaml show how its like to run on a ubuntu machine every time a code is push to the remote. The pipeline will always need to do the checkout action, this way the step will have the code that is on the repo (which will be located on the $GITHUB_WORKSPACE). Once the repo is cloned, the action will run on all the repo.

Note: This example show how to run the action as a private step. Once we publish it as a public action on the marketplace, the docs on how to use it will be available as well.