Skip to content

MissingWorkflowName

Workflow is missing a name.

Defined by MissingNameRule which supports workflows, actions in the "Default" ruleset along with MissingJobName, MissingStepName.

Description

Having a workflow name is important for usability. The default workflow name is the file name, but it's recommended to override it for human consumption:

  • The workflow name is visible at various parts of the GitHub UI, most notably in the Actions tab.
  • It's also used in Email subjects, for example: [<org>/<repo>] Run failed: <workflow name> - <branch name> (<hash>).
  • It's also useful when opening the file for viewing or editing, to give some context of what's expected to happen in the workflow.

Note: the name: ... might be present in YAML, but if it's empty or blank, it's considered missing.

Compliant example

The workflow has a name.

example.yml

name: "My Workflow"
on: push
jobs:
  example:
    name: "My Job"
    runs-on: ubuntu-latest
    steps:
      - name: "Example"
        run: echo "Example"

Non-compliant example

The workflow is missing a name.

example.yml

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

  • Line 2: Workflow[example] is missing a name, add one to improve developer experience.