require-template-icon-name

Rule catalog ID: R056

Targeted pattern scope

Workflow-template metadata iconName property.

What this rule reports

Reports metadata files missing iconName or setting it to an empty value.

Why this rule exists

An icon improves template discoverability and chooser UX.

❌ Incorrect

{ "name": "CI", "description": "Template" }

✅ Correct

{ "name": "CI", "description": "Template", "iconName": "workflow" }

Additional examples

For larger repositories, this rule is often enabled together with one of the published presets so violations are caught in pull requests before workflow changes are merged.

ESLint flat config example

import githubActions from "eslint-plugin-github-actions-2";

export default [
  {
    files: ["**/*.{yml,yaml}"],
    plugins: {
      "github-actions": githubActions,
    },
    rules: {
      "github-actions/require-template-icon-name": "error",
    },
  },
];

When not to use it

You can disable this rule when its policy does not match your repository standards, or when equivalent enforcement is already handled by another policy tool.

Targeted pattern scope​

What this rule reports​

Why this rule exists​

❌ Incorrect​

✅ Correct​

Additional examples​

ESLint flat config example​

When not to use it​

Further reading​