Allow configuration of truthy keys

[mondeja]

Linting Github Actions configuration files I'm getting the warning truthy value should be one of [false, true] (truthy) with on keys. For discussion, is not this default behaviour too much intrusive?

The solution would be set check-keys: false in truthy configuration, but this removes the verification for all keys. Maybe an allowed-keys configuration can help in this case?

Ignore solution if someone needs it:

rules:
  truthy:
    allowed-values:
      - 'true'
      - 'false'
    check-keys: true
    ignore: |
      .github/workflows

[adrienverge]

Hello,

The solution would be set check-keys: false in truthy configuration, but this removes the verification for all keys.

What do you mean exactly with "but this removes the verification for all keys"? Can you give an example of what values you would put in this allowed-keys list?

[mondeja]

What do you mean exactly with "but this removes the verification for all keys"?

If I've another key, for example On in the file would not be checked, not?

Can you give an example of what values you would put in this allowed-keys list?

allowed-keys:
  - on

So with this On would be treated as warning but not on.

[adrienverge]

If I've another key, for example On in the file would not be checked, not?

Sure, but why would you want to detect and report On (and other possibly truthy values), if you're not interested by reporting on? Why would you want to detect and report On, but not Hey or Álvaro?

If I understand your use-case, you either want to:

• use the rule truthy with {check-keys: false} (keys can be whatever they want),
• or have a new rule (not truthy) that would check keys and forbid them if they match a list.

[mondeja]

Sorry, but I don't understand your point. What is the solution that you propose for Github Actions configuration files linting? This next?

rules:
  truthy:
    allowed-values:
      - 'true'
      - 'false'
    check-keys: true
    ignore: |
      .github/workflows

To ignore the file?

Given next Github Actions configuration file, if I remove the ignore I receive the error from yamllint:

name: pre-commit

on:
  pull_request:
  push:
    branches:
      - master

jobs:
  pre-commit:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - name: Set up Python
        uses: actions/setup-python@v2
        with:
          python-version: 3.x

Next error:

./.github/workflows/pre-commit.yml
  3:1       error    truthy value should be one of [false, true]  (truthy)

Is the on working for keys or values? Maybe I don't understand the rule at all.

[adrienverge]

If you want to use on as a key in your YAML file, you need to disable the truthy rule or use check-keys: false. From what you post, it seems like you don't want check-keys: true.

[mondeja]

Wouldn't it be helpful if you could define the keys for which the rule works? I want check-keys: true but I don't want to use this rule for on keys.

[adrienverge]

I don't think so, but maybe you have a specific use-case or example?

Why would you want to forbid On to be a key, but not on?

[mondeja]

This, for example:

name: whatever

on:
  pull_request:
  push:
    branches:
      - master

jobs:
  whatever:
    runs-on: ubuntu-latest
    steps:
      - uses: some-new-action-that/someone-implements-in-the-future@v88
        with:
          yes: false

Here yes must be linted but on simply ignored.

[mondeja]

And why not add fired to be a truthy key that must be checked, or released, or deprecated? If this rule is so arbitrary, at least that keys can be configured.

[adrienverge]

And why not add fired to be a truthy key that must be checked, or released, or deprecated? If this rule is so arbitrary, at least that keys can be configured.

Sure. As I said here, what you're talking about is a new rule (not truthy) that would check keys, and report is their value is forbidden.