Skip to main content

Variable: githubActionsRulesDefinition

const githubActionsRulesDefinition: {
  action-name-casing: typeof rule;
  job-id-casing: typeof rule;
  max-jobs-per-action: typeof rule;
  no-case-insensitive-input-id-collision: typeof rule;
  no-codeql-autobuild-for-javascript-typescript: typeof rule;
  no-codeql-javascript-typescript-split-language-matrix: typeof rule;
  no-composite-input-env-access: typeof rule;
  no-deprecated-node-runtime: typeof rule;
  no-duplicate-composite-step-id: typeof rule;
  no-empty-template-file-pattern: typeof rule;
  no-external-job: typeof rule;
  no-hardcoded-default-branch-in-template: typeof rule;
  no-icon-file-extension-in-template-icon-name: typeof rule;
  no-inherit-secrets: typeof rule;
  no-invalid-concurrency-context: typeof rule;
  no-invalid-key: typeof rule;
  no-invalid-reusable-workflow-job-key: typeof rule;
  no-invalid-template-file-pattern-regex: typeof rule;
  no-invalid-workflow-call-output-value: typeof rule;
  no-overlapping-dependabot-directories: typeof rule;
  no-path-separators-in-template-icon-name: typeof rule;
  no-post-if-without-post: typeof rule;
  no-pr-head-checkout-in-pull-request-target: typeof rule;
  no-pre-if-without-pre: typeof rule;
  no-required-input-with-default: typeof rule;
  no-secrets-in-if: typeof rule;
  no-self-hosted-runner-on-fork-pr-events: typeof rule;
  no-subdirectory-template-file-pattern: typeof rule;
  no-template-placeholder-in-non-template-workflow: typeof rule;
  no-top-level-env: typeof rule;
  no-top-level-permissions: typeof rule;
  no-universal-template-file-pattern: typeof rule;
  no-unknown-dependabot-multi-ecosystem-group: typeof rule;
  no-unknown-input-reference-in-composite: typeof rule;
  no-unknown-job-output-reference: typeof rule;
  no-unknown-step-reference: typeof rule;
  no-untrusted-input-in-run: typeof rule;
  no-unused-dependabot-enable-beta-ecosystems: typeof rule;
  no-unused-input-in-composite: typeof rule;
  no-write-all-permissions: typeof rule;
  pin-action-shas: typeof rule;
  prefer-action-yml: typeof rule;
  prefer-fail-fast: typeof rule;
  prefer-file-extension: typeof rule;
  prefer-inputs-context: typeof rule;
  prefer-step-uses-style: typeof rule;
  prefer-template-yml-extension: typeof rule;
  require-action-name: typeof rule;
  require-action-run-name: typeof rule;
  require-checkout-before-local-action: typeof rule;
  require-codeql-actions-read: typeof rule;
  require-codeql-branch-filters: typeof rule;
  require-codeql-category-when-language-matrix: typeof rule;
  require-codeql-pull-request-trigger: typeof rule;
  require-codeql-schedule: typeof rule;
  require-codeql-security-events-write: typeof rule;
  require-composite-step-name: typeof rule;
  require-dependabot-assignees: typeof rule;
  require-dependabot-automation-permissions: typeof rule;
  require-dependabot-automation-pull-request-trigger: typeof rule;
  require-dependabot-bot-actor-guard: typeof rule;
  require-dependabot-commit-message-include-scope: typeof rule;
  require-dependabot-commit-message-prefix: typeof rule;
  require-dependabot-commit-message-prefix-development: typeof rule;
  require-dependabot-cooldown: typeof rule;
  require-dependabot-directory: typeof rule;
  require-dependabot-github-actions-directory-root: typeof rule;
  require-dependabot-labels: typeof rule;
  require-dependabot-open-pull-requests-limit: typeof rule;
  require-dependabot-package-ecosystem: typeof rule;
  require-dependabot-patterns-for-multi-ecosystem-group: typeof rule;
  require-dependabot-schedule-cronjob: typeof rule;
  require-dependabot-schedule-interval: typeof rule;
  require-dependabot-schedule-time: typeof rule;
  require-dependabot-schedule-timezone: typeof rule;
  require-dependabot-target-branch: typeof rule;
  require-dependabot-updates: typeof rule;
  require-dependabot-version: typeof rule;
  require-dependabot-versioning-strategy-for-npm: typeof rule;
  require-dependency-review-action: typeof rule;
  require-dependency-review-fail-on-severity: typeof rule;
  require-dependency-review-permissions-contents-read: typeof rule;
  require-dependency-review-pull-request-trigger: typeof rule;
  require-fetch-metadata-github-token: typeof rule;
  require-job-name: typeof rule;
  require-job-step-name: typeof rule;
  require-job-timeout-minutes: typeof rule;
  require-merge-group-trigger: typeof rule;
  require-pull-request-target-branches: typeof rule;
  require-run-step-shell: typeof rule;
  require-sarif-upload-security-events-write: typeof rule;
  require-scorecard-results-format-sarif: typeof rule;
  require-scorecard-upload-sarif-step: typeof rule;
  require-secret-scan-contents-read: typeof rule;
  require-secret-scan-fetch-depth-zero: typeof rule;
  require-secret-scan-schedule: typeof rule;
  require-template-categories: typeof rule;
  require-template-file-patterns: typeof rule;
  require-template-icon-file-exists: typeof rule;
  require-template-icon-name: typeof rule;
  require-template-workflow-name: typeof rule;
  require-trigger-types: typeof rule;
  require-trufflehog-verified-results-mode: typeof rule;
  require-workflow-call-input-type: typeof rule;
  require-workflow-call-output-value: typeof rule;
  require-workflow-concurrency: typeof rule;
  require-workflow-dispatch-input-type: typeof rule;
  require-workflow-interface-description: typeof rule;
  require-workflow-permissions: typeof rule;
  require-workflow-run-branches: typeof rule;
  require-workflow-template-pair: typeof rule;
  require-workflow-template-properties-pair: typeof rule;
  valid-timeout-minutes: typeof rule;
  valid-trigger-events: typeof rule;
};

Defined in: _internal/rules-registry.ts:123

Strongly typed plugin rule registry keyed by unqualified rule name.

Type Declarationโ€‹

<a id="action-name-casing"></a>

action-name-casingโ€‹

readonly action-name-casing: typeof rule;

<a id="job-id-casing"></a>

job-id-casingโ€‹

readonly job-id-casing: typeof rule;

<a id="max-jobs-per-action"></a>

max-jobs-per-actionโ€‹

readonly max-jobs-per-action: typeof rule;

<a id="no-case-insensitive-input-id-collision"></a>

no-case-insensitive-input-id-collisionโ€‹

readonly no-case-insensitive-input-id-collision: typeof rule;

<a id="no-codeql-autobuild-for-javascript-typescript"></a>

no-codeql-autobuild-for-javascript-typescriptโ€‹

readonly no-codeql-autobuild-for-javascript-typescript: typeof rule;

<a id="no-codeql-javascript-typescript-split-language-matrix"></a>

no-codeql-javascript-typescript-split-language-matrixโ€‹

readonly no-codeql-javascript-typescript-split-language-matrix: typeof rule;

<a id="no-composite-input-env-access"></a>

no-composite-input-env-accessโ€‹

readonly no-composite-input-env-access: typeof rule;

<a id="no-deprecated-node-runtime"></a>

no-deprecated-node-runtimeโ€‹

readonly no-deprecated-node-runtime: typeof rule;

<a id="no-duplicate-composite-step-id"></a>

no-duplicate-composite-step-idโ€‹

readonly no-duplicate-composite-step-id: typeof rule;

<a id="no-empty-template-file-pattern"></a>

no-empty-template-file-patternโ€‹

readonly no-empty-template-file-pattern: typeof rule;

<a id="no-external-job"></a>

no-external-jobโ€‹

readonly no-external-job: typeof rule;

<a id="no-hardcoded-default-branch-in-template"></a>

no-hardcoded-default-branch-in-templateโ€‹

readonly no-hardcoded-default-branch-in-template: typeof rule;

<a id="no-icon-file-extension-in-template-icon-name"></a>

no-icon-file-extension-in-template-icon-nameโ€‹

readonly no-icon-file-extension-in-template-icon-name: typeof rule;

<a id="no-inherit-secrets"></a>

no-inherit-secretsโ€‹

readonly no-inherit-secrets: typeof rule;

<a id="no-invalid-concurrency-context"></a>

no-invalid-concurrency-contextโ€‹

readonly no-invalid-concurrency-context: typeof rule;

<a id="no-invalid-key"></a>

no-invalid-keyโ€‹

readonly no-invalid-key: typeof rule;

<a id="no-invalid-reusable-workflow-job-key"></a>

no-invalid-reusable-workflow-job-keyโ€‹

readonly no-invalid-reusable-workflow-job-key: typeof rule;

<a id="no-invalid-template-file-pattern-regex"></a>

no-invalid-template-file-pattern-regexโ€‹

readonly no-invalid-template-file-pattern-regex: typeof rule;

<a id="no-invalid-workflow-call-output-value"></a>

no-invalid-workflow-call-output-valueโ€‹

readonly no-invalid-workflow-call-output-value: typeof rule;

<a id="no-overlapping-dependabot-directories"></a>

no-overlapping-dependabot-directoriesโ€‹

readonly no-overlapping-dependabot-directories: typeof rule;

<a id="no-path-separators-in-template-icon-name"></a>

no-path-separators-in-template-icon-nameโ€‹

readonly no-path-separators-in-template-icon-name: typeof rule;

<a id="no-post-if-without-post"></a>

no-post-if-without-postโ€‹

readonly no-post-if-without-post: typeof rule;

<a id="no-pr-head-checkout-in-pull-request-target"></a>

no-pr-head-checkout-in-pull-request-targetโ€‹

readonly no-pr-head-checkout-in-pull-request-target: typeof rule;

<a id="no-pre-if-without-pre"></a>

no-pre-if-without-preโ€‹

readonly no-pre-if-without-pre: typeof rule;

<a id="no-required-input-with-default"></a>

no-required-input-with-defaultโ€‹

readonly no-required-input-with-default: typeof rule;

<a id="no-secrets-in-if"></a>

no-secrets-in-ifโ€‹

readonly no-secrets-in-if: typeof rule;

<a id="no-self-hosted-runner-on-fork-pr-events"></a>

no-self-hosted-runner-on-fork-pr-eventsโ€‹

readonly no-self-hosted-runner-on-fork-pr-events: typeof rule;

<a id="no-subdirectory-template-file-pattern"></a>

no-subdirectory-template-file-patternโ€‹

readonly no-subdirectory-template-file-pattern: typeof rule;

<a id="no-template-placeholder-in-non-template-workflow"></a>

no-template-placeholder-in-non-template-workflowโ€‹

readonly no-template-placeholder-in-non-template-workflow: typeof rule;

<a id="no-top-level-env"></a>

no-top-level-envโ€‹

readonly no-top-level-env: typeof rule;

<a id="no-top-level-permissions"></a>

no-top-level-permissionsโ€‹

readonly no-top-level-permissions: typeof rule;

<a id="no-universal-template-file-pattern"></a>

no-universal-template-file-patternโ€‹

readonly no-universal-template-file-pattern: typeof rule;

<a id="no-unknown-dependabot-multi-ecosystem-group"></a>

no-unknown-dependabot-multi-ecosystem-groupโ€‹

readonly no-unknown-dependabot-multi-ecosystem-group: typeof rule;

<a id="no-unknown-input-reference-in-composite"></a>

no-unknown-input-reference-in-compositeโ€‹

readonly no-unknown-input-reference-in-composite: typeof rule;

<a id="no-unknown-job-output-reference"></a>

no-unknown-job-output-referenceโ€‹

readonly no-unknown-job-output-reference: typeof rule;

<a id="no-unknown-step-reference"></a>

no-unknown-step-referenceโ€‹

readonly no-unknown-step-reference: typeof rule;

<a id="no-untrusted-input-in-run"></a>

no-untrusted-input-in-runโ€‹

readonly no-untrusted-input-in-run: typeof rule;

<a id="no-unused-dependabot-enable-beta-ecosystems"></a>

no-unused-dependabot-enable-beta-ecosystemsโ€‹

readonly no-unused-dependabot-enable-beta-ecosystems: typeof rule;

<a id="no-unused-input-in-composite"></a>

no-unused-input-in-compositeโ€‹

readonly no-unused-input-in-composite: typeof rule;

<a id="no-write-all-permissions"></a>

no-write-all-permissionsโ€‹

readonly no-write-all-permissions: typeof rule;

<a id="pin-action-shas"></a>

pin-action-shasโ€‹

readonly pin-action-shas: typeof rule;

<a id="prefer-action-yml"></a>

prefer-action-ymlโ€‹

readonly prefer-action-yml: typeof rule;

<a id="prefer-fail-fast"></a>

prefer-fail-fastโ€‹

readonly prefer-fail-fast: typeof rule;

<a id="prefer-file-extension"></a>

prefer-file-extensionโ€‹

readonly prefer-file-extension: typeof rule;

<a id="prefer-inputs-context"></a>

prefer-inputs-contextโ€‹

readonly prefer-inputs-context: typeof rule;

<a id="prefer-step-uses-style"></a>

prefer-step-uses-styleโ€‹

readonly prefer-step-uses-style: typeof rule;

<a id="prefer-template-yml-extension"></a>

prefer-template-yml-extensionโ€‹

readonly prefer-template-yml-extension: typeof rule;

<a id="require-action-name"></a>

require-action-nameโ€‹

readonly require-action-name: typeof rule;

<a id="require-action-run-name"></a>

require-action-run-nameโ€‹

readonly require-action-run-name: typeof rule;

<a id="require-checkout-before-local-action"></a>

require-checkout-before-local-actionโ€‹

readonly require-checkout-before-local-action: typeof rule;

<a id="require-codeql-actions-read"></a>

require-codeql-actions-readโ€‹

readonly require-codeql-actions-read: typeof rule;

<a id="require-codeql-branch-filters"></a>

require-codeql-branch-filtersโ€‹

readonly require-codeql-branch-filters: typeof rule;

<a id="require-codeql-category-when-language-matrix"></a>

require-codeql-category-when-language-matrixโ€‹

readonly require-codeql-category-when-language-matrix: typeof rule;

<a id="require-codeql-pull-request-trigger"></a>

require-codeql-pull-request-triggerโ€‹

readonly require-codeql-pull-request-trigger: typeof rule;

<a id="require-codeql-schedule"></a>

require-codeql-scheduleโ€‹

readonly require-codeql-schedule: typeof rule;

<a id="require-codeql-security-events-write"></a>

require-codeql-security-events-writeโ€‹

readonly require-codeql-security-events-write: typeof rule;

<a id="require-composite-step-name"></a>

require-composite-step-nameโ€‹

readonly require-composite-step-name: typeof rule;

<a id="require-dependabot-assignees"></a>

require-dependabot-assigneesโ€‹

readonly require-dependabot-assignees: typeof rule;

<a id="require-dependabot-automation-permissions"></a>

require-dependabot-automation-permissionsโ€‹

readonly require-dependabot-automation-permissions: typeof rule;

<a id="require-dependabot-automation-pull-request-trigger"></a>

require-dependabot-automation-pull-request-triggerโ€‹

readonly require-dependabot-automation-pull-request-trigger: typeof rule;

<a id="require-dependabot-bot-actor-guard"></a>

require-dependabot-bot-actor-guardโ€‹

readonly require-dependabot-bot-actor-guard: typeof rule;

<a id="require-dependabot-commit-message-include-scope"></a>

require-dependabot-commit-message-include-scopeโ€‹

readonly require-dependabot-commit-message-include-scope: typeof rule;

<a id="require-dependabot-commit-message-prefix"></a>

require-dependabot-commit-message-prefixโ€‹

readonly require-dependabot-commit-message-prefix: typeof rule;

<a id="require-dependabot-commit-message-prefix-development"></a>

require-dependabot-commit-message-prefix-developmentโ€‹

readonly require-dependabot-commit-message-prefix-development: typeof rule;

<a id="require-dependabot-cooldown"></a>

require-dependabot-cooldownโ€‹

readonly require-dependabot-cooldown: typeof rule;

<a id="require-dependabot-directory"></a>

require-dependabot-directoryโ€‹

readonly require-dependabot-directory: typeof rule;

<a id="require-dependabot-github-actions-directory-root"></a>

require-dependabot-github-actions-directory-rootโ€‹

readonly require-dependabot-github-actions-directory-root: typeof rule;

<a id="require-dependabot-labels"></a>

require-dependabot-labelsโ€‹

readonly require-dependabot-labels: typeof rule;

<a id="require-dependabot-open-pull-requests-limit"></a>

require-dependabot-open-pull-requests-limitโ€‹

readonly require-dependabot-open-pull-requests-limit: typeof rule;

<a id="require-dependabot-package-ecosystem"></a>

require-dependabot-package-ecosystemโ€‹

readonly require-dependabot-package-ecosystem: typeof rule;

<a id="require-dependabot-patterns-for-multi-ecosystem-group"></a>

require-dependabot-patterns-for-multi-ecosystem-groupโ€‹

readonly require-dependabot-patterns-for-multi-ecosystem-group: typeof rule;

<a id="require-dependabot-schedule-cronjob"></a>

require-dependabot-schedule-cronjobโ€‹

readonly require-dependabot-schedule-cronjob: typeof rule;

<a id="require-dependabot-schedule-interval"></a>

require-dependabot-schedule-intervalโ€‹

readonly require-dependabot-schedule-interval: typeof rule;

<a id="require-dependabot-schedule-time"></a>

require-dependabot-schedule-timeโ€‹

readonly require-dependabot-schedule-time: typeof rule;

<a id="require-dependabot-schedule-timezone"></a>

require-dependabot-schedule-timezoneโ€‹

readonly require-dependabot-schedule-timezone: typeof rule;

<a id="require-dependabot-target-branch"></a>

require-dependabot-target-branchโ€‹

readonly require-dependabot-target-branch: typeof rule;

<a id="require-dependabot-updates"></a>

require-dependabot-updatesโ€‹

readonly require-dependabot-updates: typeof rule;

<a id="require-dependabot-version"></a>

require-dependabot-versionโ€‹

readonly require-dependabot-version: typeof rule;

<a id="require-dependabot-versioning-strategy-for-npm"></a>

require-dependabot-versioning-strategy-for-npmโ€‹

readonly require-dependabot-versioning-strategy-for-npm: typeof rule;

<a id="require-dependency-review-action"></a>

require-dependency-review-actionโ€‹

readonly require-dependency-review-action: typeof rule;

<a id="require-dependency-review-fail-on-severity"></a>

require-dependency-review-fail-on-severityโ€‹

readonly require-dependency-review-fail-on-severity: typeof rule;

<a id="require-dependency-review-permissions-contents-read"></a>

require-dependency-review-permissions-contents-readโ€‹

readonly require-dependency-review-permissions-contents-read: typeof rule;

<a id="require-dependency-review-pull-request-trigger"></a>

require-dependency-review-pull-request-triggerโ€‹

readonly require-dependency-review-pull-request-trigger: typeof rule;

<a id="require-fetch-metadata-github-token"></a>

require-fetch-metadata-github-tokenโ€‹

readonly require-fetch-metadata-github-token: typeof rule;

<a id="require-job-name"></a>

require-job-nameโ€‹

readonly require-job-name: typeof rule;

<a id="require-job-step-name"></a>

require-job-step-nameโ€‹

readonly require-job-step-name: typeof rule;

<a id="require-job-timeout-minutes"></a>

require-job-timeout-minutesโ€‹

readonly require-job-timeout-minutes: typeof rule;

<a id="require-merge-group-trigger"></a>

require-merge-group-triggerโ€‹

readonly require-merge-group-trigger: typeof rule;

<a id="require-pull-request-target-branches"></a>

require-pull-request-target-branchesโ€‹

readonly require-pull-request-target-branches: typeof rule;

<a id="require-run-step-shell"></a>

require-run-step-shellโ€‹

readonly require-run-step-shell: typeof rule;

<a id="require-sarif-upload-security-events-write"></a>

require-sarif-upload-security-events-writeโ€‹

readonly require-sarif-upload-security-events-write: typeof rule;

<a id="require-scorecard-results-format-sarif"></a>

require-scorecard-results-format-sarifโ€‹

readonly require-scorecard-results-format-sarif: typeof rule;

<a id="require-scorecard-upload-sarif-step"></a>

require-scorecard-upload-sarif-stepโ€‹

readonly require-scorecard-upload-sarif-step: typeof rule;

<a id="require-secret-scan-contents-read"></a>

require-secret-scan-contents-readโ€‹

readonly require-secret-scan-contents-read: typeof rule;

<a id="require-secret-scan-fetch-depth-zero"></a>

require-secret-scan-fetch-depth-zeroโ€‹

readonly require-secret-scan-fetch-depth-zero: typeof rule;

<a id="require-secret-scan-schedule"></a>

require-secret-scan-scheduleโ€‹

readonly require-secret-scan-schedule: typeof rule;

<a id="require-template-categories"></a>

require-template-categoriesโ€‹

readonly require-template-categories: typeof rule;

<a id="require-template-file-patterns"></a>

require-template-file-patternsโ€‹

readonly require-template-file-patterns: typeof rule;

<a id="require-template-icon-file-exists"></a>

require-template-icon-file-existsโ€‹

readonly require-template-icon-file-exists: typeof rule;

<a id="require-template-icon-name"></a>

require-template-icon-nameโ€‹

readonly require-template-icon-name: typeof rule;

<a id="require-template-workflow-name"></a>

require-template-workflow-nameโ€‹

readonly require-template-workflow-name: typeof rule;

<a id="require-trigger-types"></a>

require-trigger-typesโ€‹

readonly require-trigger-types: typeof rule;

<a id="require-trufflehog-verified-results-mode"></a>

require-trufflehog-verified-results-modeโ€‹

readonly require-trufflehog-verified-results-mode: typeof rule;

<a id="require-workflow-call-input-type"></a>

require-workflow-call-input-typeโ€‹

readonly require-workflow-call-input-type: typeof rule;

<a id="require-workflow-call-output-value"></a>

require-workflow-call-output-valueโ€‹

readonly require-workflow-call-output-value: typeof rule;

<a id="require-workflow-concurrency"></a>

require-workflow-concurrencyโ€‹

readonly require-workflow-concurrency: typeof rule;

<a id="require-workflow-dispatch-input-type"></a>

require-workflow-dispatch-input-typeโ€‹

readonly require-workflow-dispatch-input-type: typeof rule;

<a id="require-workflow-interface-description"></a>

require-workflow-interface-descriptionโ€‹

readonly require-workflow-interface-description: typeof rule;

<a id="require-workflow-permissions"></a>

require-workflow-permissionsโ€‹

readonly require-workflow-permissions: typeof rule;

<a id="require-workflow-run-branches"></a>

require-workflow-run-branchesโ€‹

readonly require-workflow-run-branches: typeof rule;

<a id="require-workflow-template-pair"></a>

require-workflow-template-pairโ€‹

readonly require-workflow-template-pair: typeof rule;

<a id="require-workflow-template-properties-pair"></a>

require-workflow-template-properties-pairโ€‹

readonly require-workflow-template-properties-pair: typeof rule;

<a id="valid-timeout-minutes"></a>

valid-timeout-minutesโ€‹

readonly valid-timeout-minutes: typeof rule;

<a id="valid-trigger-events"></a>

valid-trigger-eventsโ€‹

readonly valid-trigger-events: typeof rule;