require-workflow-template-properties-pair
Rule catalog ID: R055
Targeted pattern scopeโ
Workflow-template metadata files ending with .properties.json.
What this rule reportsโ
Reports metadata files that do not have matching .yml/.yaml template workflow files.
Why this rule existsโ
Orphan metadata files are dead configuration and mislead maintainers.
โ Incorrectโ
workflow-templates/ci.properties.json
โ Correctโ
workflow-templates/ci.properties.json
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/require-workflow-template-properties-pair": "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.