Inclusivelint Github Actions

Overview

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.

Using it as part of the pipeline (private action)

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.

Using it as part of the pipeline (public action from github action)

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 from Marketplace
        uses: 'inclusivelint/inclusivelint-github-actions@0.0.1'

In this case, the yaml is using the public action from github marketplace. It runs exactly like the private one, the difference is that you don't need to have the action code the repo you want to run inclusivelint.

Contributing

Contributions are more then welcome in this repository. If you experience some bugs or there are some features you'd like to have as part of the tool, please feel free to open an issue describing the situation to us.

If you want to open a PR, the suggested way of doing this is the following:

1. Fork this repository
2. Clone the fork
3. Create a branch on the fork with a name that follows the pattern <github_user>/<new_feature>
4. Once the work is done, feel free to open a PR to the main branch of this repo