canonical / inclusive-naming

A Github action to check for the use of non-inclusive language

Inclusive naming action

A github action that checks code for non-inclusive language and makes suggestions on alternate language.

Installation

To use this check on your project add following action to your /.github/workflows:

name: Inclusive naming PR check
on: pull_request

jobs:
  call-inclusive-naming-check:
    name: Inclusive naming
    uses: canonical-web-and-design/Inclusive-naming/.github/workflows/woke.yaml@main
    with:
      fail-on-error: "true"

Configuration

The words that are flagged by the action and their corresponding alternatives can be found in the config.yml file. To add a word, find the appropriate section (or create a new one if needed) and add the the word to be flagged and suggested alternatives in the following style:

  - name: whitelist
    terms:
      - whitelist
      - white-list
    alternatives:
      - allowlist
    severity: error

Right now all words severity is being set to 'error'

inclusive-naming's Issues

Add an exclude arg

In charmland we vendor charmlibs, which are files that live in ./lib.
We do not want the action to fail a PR if a vendored lib has e.g. Dummy in it.

It would be handy if the action had an arg for exclusions.

Take the following tree for example:

.
├── lib
│   └── charms
│       ├── alertmanager_k8s
│       ├── catalogue_k8s
│       ├── grafana_k8s
│       ├── observability_libs
│       ├── prometheus_k8s
│       ├── tls_certificates_interface
│       └── traefik_k8s
├── src
└── tests

We want to scan ., but from the lib/charms folder, we only want to scan prometheus_k8s.
With an exclude arg we would be able to easily have our CI

1. scan ., excluding ./lib; and
2. scan ./lib/charms/prometheus_k8s.

False positive for URLs

We use the canonical-web-and-design/Inclusive-naming/.github/workflows/woke.yaml@main action in our centralized CI.
Recently a workflow failed for having master as part of a URL in a comment:

# - https://github.com/kubernetes/kube-state-metrics/blob/master/CHANGELOG.md#v200-alpha--2020-09-16

This seems like a false positive.

Add the term "person hours" as another alternative to "man hours"

Just a suggestion based on my own experience using the term

Install Woke the recommended way to avoid errors

Jobs often fail like this:

We install Woke in a weird way that's hard to unpick. I'm not sure where we got this method from.

Woke has some clear documentation about how to install it in GitHub workflows. Can't we follow something closer to that?