Skip to content

WorkflowIdNaming

Workflow should have a lower-case kebab ID.

Defined by IdNamingRule which supports workflows, actions in the "Default" ruleset along with JobIdNaming, StepIdNaming.

Description

Workflows are defined by a YAML file checked in to your repository -- About workflows

This means their names could be pretty much anything that's a valid file name. Conventionally it's best to use lower-kebab-case naming for workflow file names.

Workflow IDs (or their file names) appear

  • in GitHub's Actions tab URLs, e.g.: https://github.com/TWiStErRob/net.twisterrob.ghlint/actions/workflows/ci-build.yml
  • in commands / shell scripts when triggering a workflow_dispatch event from gh CLI.

Compliant example

Workflow file has conventional lower-kebab-case name.

ci-build.yml 

on: push
jobs:
  example:
    runs-on: ubuntu-latest
    steps:
      - run: echo "Example"

Non-compliant example

Workflow has non-lower-kebab-case IDs.

CI build.yml 

on: push
jobs:
  example:
    runs-on: ubuntu-latest
    steps:
      - run: echo "Example"

  • Line 2: Workflow[CI build] should have a lower-case kebab ID.