Skip to main content

no-unknown-input-reference-in-composite

Rule catalog ID: R050

Targeted pattern scopeโ€‹

Composite action metadata strings that reference inputs.<id>.

What this rule reportsโ€‹

Reports inputs.<id> references when <id> is not declared under inputs.

Why this rule existsโ€‹

Typos in input references make composite actions behave incorrectly at runtime.

โŒ Incorrectโ€‹

inputs:
token:
description: Token
runs:
using: composite
steps:
- run: echo "${{ inputs.tokne }}"
shell: bash

โœ… Correctโ€‹

inputs:
token:
description: Token
runs:
using: composite
steps:
- run: echo "${{ inputs.token }}"
shell: bash

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-unknown-input-reference-in-composite": "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โ€‹