require-template-categories
Rule catalog ID: R057
Targeted pattern scopeโ
Workflow-template metadata categories property.
What this rule reportsโ
Reports missing or empty categories arrays.
Why this rule existsโ
Categories improve filterability and ranking in the workflow template chooser.
โ Incorrectโ
{ "name": "CI", "description": "Template", "iconName": "workflow" }
โ Correctโ
{
"name": "CI",
"description": "Template",
"iconName": "workflow",
"categories": ["JavaScript"]
}
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-categories": "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.