Skip to main content

prefer-template-yml-extension

Rule catalog ID: R066

Targeted pattern scopeโ€‹

Workflow template YAML filenames under workflow-templates/.

What this rule reportsโ€‹

Reports template files that use .yaml instead of .yml.

Why this rule existsโ€‹

Consistent file extensions improve discoverability and repository conventions.

โŒ Incorrectโ€‹

workflow-templates/ci.yaml

โœ… Correctโ€‹

workflow-templates/ci.yml

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/prefer-template-yml-extension": "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.

Further readingโ€‹