no-hardcoded-default-branch-in-template
Rule catalog ID: R068
Targeted pattern scopeโ
Workflow template YAML files under workflow-templates/.
What this rule reportsโ
Reports hardcoded main and master branch literals.
Why this rule existsโ
Template workflows should use $default-branch so generated workflows match the target repository.
โ Incorrectโ
on:
push:
branches:
- main
โ Correctโ
on:
push:
branches:
- $default-branch
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/no-hardcoded-default-branch-in-template": "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.