eslint-plugin-github-actions-2 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +7 -0
- package/LICENSE +21 -0
- package/README.md +164 -0
- package/dist/_internal/case-police-dictionary.d.ts +10 -0
- package/dist/_internal/case-police-dictionary.d.ts.map +1 -0
- package/dist/_internal/case-police-dictionary.js +486 -0
- package/dist/_internal/case-police-dictionary.js.map +1 -0
- package/dist/_internal/casing.d.ts +17 -0
- package/dist/_internal/casing.d.ts.map +1 -0
- package/dist/_internal/casing.js +197 -0
- package/dist/_internal/casing.js.map +1 -0
- package/dist/_internal/github-actions-config-references.d.ts +16 -0
- package/dist/_internal/github-actions-config-references.d.ts.map +1 -0
- package/dist/_internal/github-actions-config-references.js +76 -0
- package/dist/_internal/github-actions-config-references.js.map +1 -0
- package/dist/_internal/github-actions-trigger-events.d.ts +13 -0
- package/dist/_internal/github-actions-trigger-events.d.ts.map +1 -0
- package/dist/_internal/github-actions-trigger-events.js +47 -0
- package/dist/_internal/github-actions-trigger-events.js.map +1 -0
- package/dist/_internal/github-expressions.d.ts +9 -0
- package/dist/_internal/github-expressions.d.ts.map +1 -0
- package/dist/_internal/github-expressions.js +87 -0
- package/dist/_internal/github-expressions.js.map +1 -0
- package/dist/_internal/lint-targets.d.ts +21 -0
- package/dist/_internal/lint-targets.d.ts.map +1 -0
- package/dist/_internal/lint-targets.js +60 -0
- package/dist/_internal/lint-targets.js.map +1 -0
- package/dist/_internal/rule-docs.d.ts +16 -0
- package/dist/_internal/rule-docs.d.ts.map +1 -0
- package/dist/_internal/rule-docs.js +2 -0
- package/dist/_internal/rule-docs.js.map +1 -0
- package/dist/_internal/rules-registry.d.ts +145 -0
- package/dist/_internal/rules-registry.d.ts.map +1 -0
- package/dist/_internal/rules-registry.js +144 -0
- package/dist/_internal/rules-registry.js.map +1 -0
- package/dist/_internal/workflow-template-properties.d.ts +20 -0
- package/dist/_internal/workflow-template-properties.d.ts.map +1 -0
- package/dist/_internal/workflow-template-properties.js +44 -0
- package/dist/_internal/workflow-template-properties.js.map +1 -0
- package/dist/_internal/workflow-yaml.d.ts +47 -0
- package/dist/_internal/workflow-yaml.d.ts.map +1 -0
- package/dist/_internal/workflow-yaml.js +140 -0
- package/dist/_internal/workflow-yaml.js.map +1 -0
- package/dist/_internal/yaml-traversal.d.ts +10 -0
- package/dist/_internal/yaml-traversal.d.ts.map +1 -0
- package/dist/_internal/yaml-traversal.js +38 -0
- package/dist/_internal/yaml-traversal.js.map +1 -0
- package/dist/plugin.cjs +7107 -0
- package/dist/plugin.cjs.map +7 -0
- package/dist/plugin.d.cts +34 -0
- package/dist/plugin.d.ts +34 -0
- package/dist/plugin.d.ts.map +1 -0
- package/dist/plugin.js +122 -0
- package/dist/plugin.js.map +1 -0
- package/dist/rules/action-name-casing.d.ts +9 -0
- package/dist/rules/action-name-casing.d.ts.map +1 -0
- package/dist/rules/action-name-casing.js +141 -0
- package/dist/rules/action-name-casing.js.map +1 -0
- package/dist/rules/job-id-casing.d.ts +9 -0
- package/dist/rules/job-id-casing.d.ts.map +1 -0
- package/dist/rules/job-id-casing.js +123 -0
- package/dist/rules/job-id-casing.js.map +1 -0
- package/dist/rules/max-jobs-per-action.d.ts +9 -0
- package/dist/rules/max-jobs-per-action.d.ts.map +1 -0
- package/dist/rules/max-jobs-per-action.js +61 -0
- package/dist/rules/max-jobs-per-action.js.map +1 -0
- package/dist/rules/no-case-insensitive-input-id-collision.d.ts +9 -0
- package/dist/rules/no-case-insensitive-input-id-collision.d.ts.map +1 -0
- package/dist/rules/no-case-insensitive-input-id-collision.js +66 -0
- package/dist/rules/no-case-insensitive-input-id-collision.js.map +1 -0
- package/dist/rules/no-composite-input-env-access.d.ts +9 -0
- package/dist/rules/no-composite-input-env-access.d.ts.map +1 -0
- package/dist/rules/no-composite-input-env-access.js +62 -0
- package/dist/rules/no-composite-input-env-access.js.map +1 -0
- package/dist/rules/no-deprecated-node-runtime.d.ts +9 -0
- package/dist/rules/no-deprecated-node-runtime.d.ts.map +1 -0
- package/dist/rules/no-deprecated-node-runtime.js +59 -0
- package/dist/rules/no-deprecated-node-runtime.js.map +1 -0
- package/dist/rules/no-duplicate-composite-step-id.d.ts +9 -0
- package/dist/rules/no-duplicate-composite-step-id.d.ts.map +1 -0
- package/dist/rules/no-duplicate-composite-step-id.js +74 -0
- package/dist/rules/no-duplicate-composite-step-id.js.map +1 -0
- package/dist/rules/no-empty-template-file-pattern.d.ts +9 -0
- package/dist/rules/no-empty-template-file-pattern.d.ts.map +1 -0
- package/dist/rules/no-empty-template-file-pattern.js +49 -0
- package/dist/rules/no-empty-template-file-pattern.js.map +1 -0
- package/dist/rules/no-external-job.d.ts +9 -0
- package/dist/rules/no-external-job.d.ts.map +1 -0
- package/dist/rules/no-external-job.js +49 -0
- package/dist/rules/no-external-job.js.map +1 -0
- package/dist/rules/no-hardcoded-default-branch-in-template.d.ts +9 -0
- package/dist/rules/no-hardcoded-default-branch-in-template.d.ts.map +1 -0
- package/dist/rules/no-hardcoded-default-branch-in-template.js +54 -0
- package/dist/rules/no-hardcoded-default-branch-in-template.js.map +1 -0
- package/dist/rules/no-icon-file-extension-in-template-icon-name.d.ts +9 -0
- package/dist/rules/no-icon-file-extension-in-template-icon-name.d.ts.map +1 -0
- package/dist/rules/no-icon-file-extension-in-template-icon-name.js +54 -0
- package/dist/rules/no-icon-file-extension-in-template-icon-name.js.map +1 -0
- package/dist/rules/no-inherit-secrets.d.ts +9 -0
- package/dist/rules/no-inherit-secrets.d.ts.map +1 -0
- package/dist/rules/no-inherit-secrets.js +57 -0
- package/dist/rules/no-inherit-secrets.js.map +1 -0
- package/dist/rules/no-invalid-concurrency-context.d.ts +9 -0
- package/dist/rules/no-invalid-concurrency-context.d.ts.map +1 -0
- package/dist/rules/no-invalid-concurrency-context.js +141 -0
- package/dist/rules/no-invalid-concurrency-context.js.map +1 -0
- package/dist/rules/no-invalid-key.d.ts +9 -0
- package/dist/rules/no-invalid-key.d.ts.map +1 -0
- package/dist/rules/no-invalid-key.js +152 -0
- package/dist/rules/no-invalid-key.js.map +1 -0
- package/dist/rules/no-invalid-reusable-workflow-job-key.d.ts +9 -0
- package/dist/rules/no-invalid-reusable-workflow-job-key.d.ts.map +1 -0
- package/dist/rules/no-invalid-reusable-workflow-job-key.js +73 -0
- package/dist/rules/no-invalid-reusable-workflow-job-key.js.map +1 -0
- package/dist/rules/no-invalid-template-file-pattern-regex.d.ts +9 -0
- package/dist/rules/no-invalid-template-file-pattern-regex.d.ts.map +1 -0
- package/dist/rules/no-invalid-template-file-pattern-regex.js +58 -0
- package/dist/rules/no-invalid-template-file-pattern-regex.js.map +1 -0
- package/dist/rules/no-invalid-workflow-call-output-value.d.ts +9 -0
- package/dist/rules/no-invalid-workflow-call-output-value.d.ts.map +1 -0
- package/dist/rules/no-invalid-workflow-call-output-value.js +99 -0
- package/dist/rules/no-invalid-workflow-call-output-value.js.map +1 -0
- package/dist/rules/no-path-separators-in-template-icon-name.d.ts +9 -0
- package/dist/rules/no-path-separators-in-template-icon-name.d.ts.map +1 -0
- package/dist/rules/no-path-separators-in-template-icon-name.js +52 -0
- package/dist/rules/no-path-separators-in-template-icon-name.js.map +1 -0
- package/dist/rules/no-post-if-without-post.d.ts +9 -0
- package/dist/rules/no-post-if-without-post.d.ts.map +1 -0
- package/dist/rules/no-post-if-without-post.js +52 -0
- package/dist/rules/no-post-if-without-post.js.map +1 -0
- package/dist/rules/no-pr-head-checkout-in-pull-request-target.d.ts +12 -0
- package/dist/rules/no-pr-head-checkout-in-pull-request-target.d.ts.map +1 -0
- package/dist/rules/no-pr-head-checkout-in-pull-request-target.js +89 -0
- package/dist/rules/no-pr-head-checkout-in-pull-request-target.js.map +1 -0
- package/dist/rules/no-pre-if-without-pre.d.ts +9 -0
- package/dist/rules/no-pre-if-without-pre.d.ts.map +1 -0
- package/dist/rules/no-pre-if-without-pre.js +51 -0
- package/dist/rules/no-pre-if-without-pre.js.map +1 -0
- package/dist/rules/no-required-input-with-default.d.ts +9 -0
- package/dist/rules/no-required-input-with-default.d.ts.map +1 -0
- package/dist/rules/no-required-input-with-default.js +68 -0
- package/dist/rules/no-required-input-with-default.js.map +1 -0
- package/dist/rules/no-secrets-in-if.d.ts +9 -0
- package/dist/rules/no-secrets-in-if.d.ts.map +1 -0
- package/dist/rules/no-secrets-in-if.js +84 -0
- package/dist/rules/no-secrets-in-if.js.map +1 -0
- package/dist/rules/no-self-hosted-runner-on-fork-pr-events.d.ts +9 -0
- package/dist/rules/no-self-hosted-runner-on-fork-pr-events.d.ts.map +1 -0
- package/dist/rules/no-self-hosted-runner-on-fork-pr-events.js +93 -0
- package/dist/rules/no-self-hosted-runner-on-fork-pr-events.js.map +1 -0
- package/dist/rules/no-subdirectory-template-file-pattern.d.ts +9 -0
- package/dist/rules/no-subdirectory-template-file-pattern.d.ts.map +1 -0
- package/dist/rules/no-subdirectory-template-file-pattern.js +52 -0
- package/dist/rules/no-subdirectory-template-file-pattern.js.map +1 -0
- package/dist/rules/no-template-placeholder-in-non-template-workflow.d.ts +9 -0
- package/dist/rules/no-template-placeholder-in-non-template-workflow.d.ts.map +1 -0
- package/dist/rules/no-template-placeholder-in-non-template-workflow.js +55 -0
- package/dist/rules/no-template-placeholder-in-non-template-workflow.js.map +1 -0
- package/dist/rules/no-top-level-env.d.ts +9 -0
- package/dist/rules/no-top-level-env.d.ts.map +1 -0
- package/dist/rules/no-top-level-env.js +42 -0
- package/dist/rules/no-top-level-env.js.map +1 -0
- package/dist/rules/no-top-level-permissions.d.ts +9 -0
- package/dist/rules/no-top-level-permissions.d.ts.map +1 -0
- package/dist/rules/no-top-level-permissions.js +39 -0
- package/dist/rules/no-top-level-permissions.js.map +1 -0
- package/dist/rules/no-universal-template-file-pattern.d.ts +9 -0
- package/dist/rules/no-universal-template-file-pattern.d.ts.map +1 -0
- package/dist/rules/no-universal-template-file-pattern.js +60 -0
- package/dist/rules/no-universal-template-file-pattern.js.map +1 -0
- package/dist/rules/no-unknown-input-reference-in-composite.d.ts +9 -0
- package/dist/rules/no-unknown-input-reference-in-composite.d.ts.map +1 -0
- package/dist/rules/no-unknown-input-reference-in-composite.js +80 -0
- package/dist/rules/no-unknown-input-reference-in-composite.js.map +1 -0
- package/dist/rules/no-unknown-job-output-reference.d.ts +9 -0
- package/dist/rules/no-unknown-job-output-reference.d.ts.map +1 -0
- package/dist/rules/no-unknown-job-output-reference.js +229 -0
- package/dist/rules/no-unknown-job-output-reference.js.map +1 -0
- package/dist/rules/no-unknown-step-reference.d.ts +9 -0
- package/dist/rules/no-unknown-step-reference.d.ts.map +1 -0
- package/dist/rules/no-unknown-step-reference.js +133 -0
- package/dist/rules/no-unknown-step-reference.js.map +1 -0
- package/dist/rules/no-untrusted-input-in-run.d.ts +9 -0
- package/dist/rules/no-untrusted-input-in-run.d.ts.map +1 -0
- package/dist/rules/no-untrusted-input-in-run.js +115 -0
- package/dist/rules/no-untrusted-input-in-run.js.map +1 -0
- package/dist/rules/no-unused-input-in-composite.d.ts +9 -0
- package/dist/rules/no-unused-input-in-composite.d.ts.map +1 -0
- package/dist/rules/no-unused-input-in-composite.js +78 -0
- package/dist/rules/no-unused-input-in-composite.js.map +1 -0
- package/dist/rules/no-write-all-permissions.d.ts +9 -0
- package/dist/rules/no-write-all-permissions.d.ts.map +1 -0
- package/dist/rules/no-write-all-permissions.js +61 -0
- package/dist/rules/no-write-all-permissions.js.map +1 -0
- package/dist/rules/pin-action-shas.d.ts +12 -0
- package/dist/rules/pin-action-shas.d.ts.map +1 -0
- package/dist/rules/pin-action-shas.js +100 -0
- package/dist/rules/pin-action-shas.js.map +1 -0
- package/dist/rules/prefer-action-yml.d.ts +9 -0
- package/dist/rules/prefer-action-yml.d.ts.map +1 -0
- package/dist/rules/prefer-action-yml.js +37 -0
- package/dist/rules/prefer-action-yml.js.map +1 -0
- package/dist/rules/prefer-fail-fast.d.ts +9 -0
- package/dist/rules/prefer-fail-fast.d.ts.map +1 -0
- package/dist/rules/prefer-fail-fast.js +61 -0
- package/dist/rules/prefer-fail-fast.js.map +1 -0
- package/dist/rules/prefer-file-extension.d.ts +9 -0
- package/dist/rules/prefer-file-extension.d.ts.map +1 -0
- package/dist/rules/prefer-file-extension.js +104 -0
- package/dist/rules/prefer-file-extension.js.map +1 -0
- package/dist/rules/prefer-inputs-context.d.ts +9 -0
- package/dist/rules/prefer-inputs-context.d.ts.map +1 -0
- package/dist/rules/prefer-inputs-context.js +91 -0
- package/dist/rules/prefer-inputs-context.js.map +1 -0
- package/dist/rules/prefer-step-uses-style.d.ts +9 -0
- package/dist/rules/prefer-step-uses-style.d.ts.map +1 -0
- package/dist/rules/prefer-step-uses-style.js +209 -0
- package/dist/rules/prefer-step-uses-style.js.map +1 -0
- package/dist/rules/prefer-template-yml-extension.d.ts +9 -0
- package/dist/rules/prefer-template-yml-extension.d.ts.map +1 -0
- package/dist/rules/prefer-template-yml-extension.js +41 -0
- package/dist/rules/prefer-template-yml-extension.js.map +1 -0
- package/dist/rules/require-action-name.d.ts +9 -0
- package/dist/rules/require-action-name.d.ts.map +1 -0
- package/dist/rules/require-action-name.js +57 -0
- package/dist/rules/require-action-name.js.map +1 -0
- package/dist/rules/require-action-run-name.d.ts +9 -0
- package/dist/rules/require-action-run-name.d.ts.map +1 -0
- package/dist/rules/require-action-run-name.js +56 -0
- package/dist/rules/require-action-run-name.js.map +1 -0
- package/dist/rules/require-checkout-before-local-action.d.ts +9 -0
- package/dist/rules/require-checkout-before-local-action.d.ts.map +1 -0
- package/dist/rules/require-checkout-before-local-action.js +74 -0
- package/dist/rules/require-checkout-before-local-action.js.map +1 -0
- package/dist/rules/require-composite-step-name.d.ts +9 -0
- package/dist/rules/require-composite-step-name.d.ts.map +1 -0
- package/dist/rules/require-composite-step-name.js +67 -0
- package/dist/rules/require-composite-step-name.js.map +1 -0
- package/dist/rules/require-job-name.d.ts +9 -0
- package/dist/rules/require-job-name.d.ts.map +1 -0
- package/dist/rules/require-job-name.js +70 -0
- package/dist/rules/require-job-name.js.map +1 -0
- package/dist/rules/require-job-step-name.d.ts +9 -0
- package/dist/rules/require-job-step-name.d.ts.map +1 -0
- package/dist/rules/require-job-step-name.js +71 -0
- package/dist/rules/require-job-step-name.js.map +1 -0
- package/dist/rules/require-job-timeout-minutes.d.ts +9 -0
- package/dist/rules/require-job-timeout-minutes.d.ts.map +1 -0
- package/dist/rules/require-job-timeout-minutes.js +99 -0
- package/dist/rules/require-job-timeout-minutes.js.map +1 -0
- package/dist/rules/require-merge-group-trigger.d.ts +9 -0
- package/dist/rules/require-merge-group-trigger.d.ts.map +1 -0
- package/dist/rules/require-merge-group-trigger.js +65 -0
- package/dist/rules/require-merge-group-trigger.js.map +1 -0
- package/dist/rules/require-pull-request-target-branches.d.ts +9 -0
- package/dist/rules/require-pull-request-target-branches.d.ts.map +1 -0
- package/dist/rules/require-pull-request-target-branches.js +102 -0
- package/dist/rules/require-pull-request-target-branches.js.map +1 -0
- package/dist/rules/require-run-step-shell.d.ts +9 -0
- package/dist/rules/require-run-step-shell.d.ts.map +1 -0
- package/dist/rules/require-run-step-shell.js +114 -0
- package/dist/rules/require-run-step-shell.js.map +1 -0
- package/dist/rules/require-template-categories.d.ts +9 -0
- package/dist/rules/require-template-categories.d.ts.map +1 -0
- package/dist/rules/require-template-categories.js +55 -0
- package/dist/rules/require-template-categories.js.map +1 -0
- package/dist/rules/require-template-file-patterns.d.ts +9 -0
- package/dist/rules/require-template-file-patterns.d.ts.map +1 -0
- package/dist/rules/require-template-file-patterns.js +55 -0
- package/dist/rules/require-template-file-patterns.js.map +1 -0
- package/dist/rules/require-template-icon-file-exists.d.ts +9 -0
- package/dist/rules/require-template-icon-file-exists.d.ts.map +1 -0
- package/dist/rules/require-template-icon-file-exists.js +61 -0
- package/dist/rules/require-template-icon-file-exists.js.map +1 -0
- package/dist/rules/require-template-icon-name.d.ts +9 -0
- package/dist/rules/require-template-icon-name.d.ts.map +1 -0
- package/dist/rules/require-template-icon-name.js +48 -0
- package/dist/rules/require-template-icon-name.js.map +1 -0
- package/dist/rules/require-template-workflow-name.d.ts +9 -0
- package/dist/rules/require-template-workflow-name.d.ts.map +1 -0
- package/dist/rules/require-template-workflow-name.js +48 -0
- package/dist/rules/require-template-workflow-name.js.map +1 -0
- package/dist/rules/require-trigger-types.d.ts +9 -0
- package/dist/rules/require-trigger-types.d.ts.map +1 -0
- package/dist/rules/require-trigger-types.js +126 -0
- package/dist/rules/require-trigger-types.js.map +1 -0
- package/dist/rules/require-workflow-call-input-type.d.ts +9 -0
- package/dist/rules/require-workflow-call-input-type.d.ts.map +1 -0
- package/dist/rules/require-workflow-call-input-type.js +89 -0
- package/dist/rules/require-workflow-call-input-type.js.map +1 -0
- package/dist/rules/require-workflow-call-output-value.d.ts +9 -0
- package/dist/rules/require-workflow-call-output-value.d.ts.map +1 -0
- package/dist/rules/require-workflow-call-output-value.js +79 -0
- package/dist/rules/require-workflow-call-output-value.js.map +1 -0
- package/dist/rules/require-workflow-concurrency.d.ts +9 -0
- package/dist/rules/require-workflow-concurrency.d.ts.map +1 -0
- package/dist/rules/require-workflow-concurrency.js +157 -0
- package/dist/rules/require-workflow-concurrency.js.map +1 -0
- package/dist/rules/require-workflow-dispatch-input-type.d.ts +9 -0
- package/dist/rules/require-workflow-dispatch-input-type.d.ts.map +1 -0
- package/dist/rules/require-workflow-dispatch-input-type.js +80 -0
- package/dist/rules/require-workflow-dispatch-input-type.js.map +1 -0
- package/dist/rules/require-workflow-interface-description.d.ts +9 -0
- package/dist/rules/require-workflow-interface-description.d.ts.map +1 -0
- package/dist/rules/require-workflow-interface-description.js +98 -0
- package/dist/rules/require-workflow-interface-description.js.map +1 -0
- package/dist/rules/require-workflow-permissions.d.ts +9 -0
- package/dist/rules/require-workflow-permissions.d.ts.map +1 -0
- package/dist/rules/require-workflow-permissions.js +83 -0
- package/dist/rules/require-workflow-permissions.js.map +1 -0
- package/dist/rules/require-workflow-run-branches.d.ts +9 -0
- package/dist/rules/require-workflow-run-branches.d.ts.map +1 -0
- package/dist/rules/require-workflow-run-branches.js +84 -0
- package/dist/rules/require-workflow-run-branches.js.map +1 -0
- package/dist/rules/require-workflow-template-pair.d.ts +9 -0
- package/dist/rules/require-workflow-template-pair.d.ts.map +1 -0
- package/dist/rules/require-workflow-template-pair.js +47 -0
- package/dist/rules/require-workflow-template-pair.js.map +1 -0
- package/dist/rules/require-workflow-template-properties-pair.d.ts +9 -0
- package/dist/rules/require-workflow-template-properties-pair.d.ts.map +1 -0
- package/dist/rules/require-workflow-template-properties-pair.js +49 -0
- package/dist/rules/require-workflow-template-properties-pair.js.map +1 -0
- package/dist/rules/valid-timeout-minutes.d.ts +9 -0
- package/dist/rules/valid-timeout-minutes.d.ts.map +1 -0
- package/dist/rules/valid-timeout-minutes.js +255 -0
- package/dist/rules/valid-timeout-minutes.js.map +1 -0
- package/dist/rules/valid-trigger-events.d.ts +9 -0
- package/dist/rules/valid-trigger-events.d.ts.map +1 -0
- package/dist/rules/valid-trigger-events.js +100 -0
- package/dist/rules/valid-trigger-events.js.map +1 -0
- package/docs/rules/action-name-casing.md +64 -0
- package/docs/rules/getting-started.md +46 -0
- package/docs/rules/job-id-casing.md +73 -0
- package/docs/rules/max-jobs-per-action.md +79 -0
- package/docs/rules/no-case-insensitive-input-id-collision.md +63 -0
- package/docs/rules/no-composite-input-env-access.md +66 -0
- package/docs/rules/no-deprecated-node-runtime.md +61 -0
- package/docs/rules/no-duplicate-composite-step-id.md +73 -0
- package/docs/rules/no-empty-template-file-pattern.md +57 -0
- package/docs/rules/no-external-job.md +66 -0
- package/docs/rules/no-hardcoded-default-branch-in-template.md +63 -0
- package/docs/rules/no-icon-file-extension-in-template-icon-name.md +57 -0
- package/docs/rules/no-inherit-secrets.md +65 -0
- package/docs/rules/no-invalid-concurrency-context.md +101 -0
- package/docs/rules/no-invalid-key.md +86 -0
- package/docs/rules/no-invalid-reusable-workflow-job-key.md +74 -0
- package/docs/rules/no-invalid-template-file-pattern-regex.md +57 -0
- package/docs/rules/no-invalid-workflow-call-output-value.md +80 -0
- package/docs/rules/no-path-separators-in-template-icon-name.md +57 -0
- package/docs/rules/no-post-if-without-post.md +64 -0
- package/docs/rules/no-pr-head-checkout-in-pull-request-target.md +83 -0
- package/docs/rules/no-pre-if-without-pre.md +64 -0
- package/docs/rules/no-required-input-with-default.md +64 -0
- package/docs/rules/no-secrets-in-if.md +70 -0
- package/docs/rules/no-self-hosted-runner-on-fork-pr-events.md +75 -0
- package/docs/rules/no-subdirectory-template-file-pattern.md +57 -0
- package/docs/rules/no-template-placeholder-in-non-template-workflow.md +63 -0
- package/docs/rules/no-top-level-env.md +64 -0
- package/docs/rules/no-top-level-permissions.md +64 -0
- package/docs/rules/no-universal-template-file-pattern.md +57 -0
- package/docs/rules/no-unknown-input-reference-in-composite.md +71 -0
- package/docs/rules/no-unknown-job-output-reference.md +88 -0
- package/docs/rules/no-unknown-step-reference.md +73 -0
- package/docs/rules/no-untrusted-input-in-run.md +74 -0
- package/docs/rules/no-unused-input-in-composite.md +71 -0
- package/docs/rules/no-write-all-permissions.md +60 -0
- package/docs/rules/overview.md +91 -0
- package/docs/rules/pin-action-shas.md +65 -0
- package/docs/rules/prefer-action-yml.md +57 -0
- package/docs/rules/prefer-fail-fast.md +72 -0
- package/docs/rules/prefer-file-extension.md +77 -0
- package/docs/rules/prefer-inputs-context.md +84 -0
- package/docs/rules/prefer-step-uses-style.md +70 -0
- package/docs/rules/prefer-template-yml-extension.md +57 -0
- package/docs/rules/presets/action-metadata.md +18 -0
- package/docs/rules/presets/all.md +76 -0
- package/docs/rules/presets/index.md +100 -0
- package/docs/rules/presets/recommended.md +26 -0
- package/docs/rules/presets/security.md +16 -0
- package/docs/rules/presets/strict.md +48 -0
- package/docs/rules/presets/workflow-template-properties.md +18 -0
- package/docs/rules/presets/workflow-templates.md +22 -0
- package/docs/rules/require-action-name.md +61 -0
- package/docs/rules/require-action-run-name.md +63 -0
- package/docs/rules/require-checkout-before-local-action.md +66 -0
- package/docs/rules/require-composite-step-name.md +66 -0
- package/docs/rules/require-job-name.md +63 -0
- package/docs/rules/require-job-step-name.md +69 -0
- package/docs/rules/require-job-timeout-minutes.md +76 -0
- package/docs/rules/require-merge-group-trigger.md +67 -0
- package/docs/rules/require-pull-request-target-branches.md +79 -0
- package/docs/rules/require-run-step-shell.md +85 -0
- package/docs/rules/require-template-categories.md +62 -0
- package/docs/rules/require-template-file-patterns.md +63 -0
- package/docs/rules/require-template-icon-file-exists.md +61 -0
- package/docs/rules/require-template-icon-name.md +57 -0
- package/docs/rules/require-template-workflow-name.md +60 -0
- package/docs/rules/require-trigger-types.md +76 -0
- package/docs/rules/require-workflow-call-input-type.md +70 -0
- package/docs/rules/require-workflow-call-output-value.md +67 -0
- package/docs/rules/require-workflow-concurrency.md +73 -0
- package/docs/rules/require-workflow-dispatch-input-type.md +70 -0
- package/docs/rules/require-workflow-interface-description.md +96 -0
- package/docs/rules/require-workflow-permissions.md +75 -0
- package/docs/rules/require-workflow-run-branches.md +66 -0
- package/docs/rules/require-workflow-template-pair.md +58 -0
- package/docs/rules/require-workflow-template-properties-pair.md +58 -0
- package/docs/rules/valid-timeout-minutes.md +74 -0
- package/docs/rules/valid-trigger-events.md +62 -0
- package/package.json +497 -0
|
@@ -0,0 +1,229 @@
|
|
|
1
|
+
import { getMappingPair, getMappingValueAsMapping, getScalarStringValue, getWorkflowJobs, getWorkflowRoot, unwrapYamlValue, } from "../_internal/workflow-yaml.js";
|
|
2
|
+
/**
|
|
3
|
+
* `needs.<job_id>.outputs.<output_name>` references inside workflow
|
|
4
|
+
* expressions.
|
|
5
|
+
*/
|
|
6
|
+
const needsOutputReferencePattern = /needs\.(?<neededJobId>[A-Z_a-z][\w-]*)\.outputs\.(?<outputName>[A-Z_a-z][\w-]*)/g;
|
|
7
|
+
/**
|
|
8
|
+
* `jobs.<job_id>.outputs.<output_name>` references inside reusable workflow
|
|
9
|
+
* outputs.
|
|
10
|
+
*/
|
|
11
|
+
const jobsOutputReferencePattern = /jobs\.(?<jobId>[A-Z_a-z][\w-]*)\.outputs\.(?<outputName>[A-Z_a-z][\w-]*)/g;
|
|
12
|
+
/** Visit every string scalar reachable from a YAML value node. */
|
|
13
|
+
const visitStringScalars = (node, visitor) => {
|
|
14
|
+
const unwrappedNode = unwrapYamlValue(node);
|
|
15
|
+
if (unwrappedNode === null) {
|
|
16
|
+
return;
|
|
17
|
+
}
|
|
18
|
+
if (unwrappedNode.type === "YAMLScalar") {
|
|
19
|
+
const value = getScalarStringValue(unwrappedNode);
|
|
20
|
+
if (value !== null) {
|
|
21
|
+
visitor(unwrappedNode, value);
|
|
22
|
+
}
|
|
23
|
+
return;
|
|
24
|
+
}
|
|
25
|
+
if (unwrappedNode.type === "YAMLSequence") {
|
|
26
|
+
for (const entry of unwrappedNode.entries) {
|
|
27
|
+
visitStringScalars(entry, visitor);
|
|
28
|
+
}
|
|
29
|
+
return;
|
|
30
|
+
}
|
|
31
|
+
if (unwrappedNode.type !== "YAMLMapping") {
|
|
32
|
+
return;
|
|
33
|
+
}
|
|
34
|
+
for (const pair of unwrappedNode.pairs) {
|
|
35
|
+
visitStringScalars(pair.value ?? null, visitor);
|
|
36
|
+
}
|
|
37
|
+
};
|
|
38
|
+
/** Collect declared output names from a job definition. */
|
|
39
|
+
const getDeclaredJobOutputNames = (jobMapping) => {
|
|
40
|
+
const outputsMapping = getMappingValueAsMapping(jobMapping, "outputs");
|
|
41
|
+
const outputNames = new Set();
|
|
42
|
+
if (outputsMapping === null) {
|
|
43
|
+
return outputNames;
|
|
44
|
+
}
|
|
45
|
+
for (const pair of outputsMapping.pairs) {
|
|
46
|
+
const outputName = getScalarStringValue(pair.key);
|
|
47
|
+
if (outputName !== null) {
|
|
48
|
+
outputNames.add(outputName);
|
|
49
|
+
}
|
|
50
|
+
}
|
|
51
|
+
return outputNames;
|
|
52
|
+
};
|
|
53
|
+
/** Collect the direct `needs` dependencies configured for a job. */
|
|
54
|
+
const getDirectNeedsJobIds = (jobMapping) => {
|
|
55
|
+
const needsPair = getMappingPair(jobMapping, "needs");
|
|
56
|
+
const needsValue = unwrapYamlValue(needsPair?.value ?? null);
|
|
57
|
+
const directNeeds = new Set();
|
|
58
|
+
if (needsValue === null) {
|
|
59
|
+
return directNeeds;
|
|
60
|
+
}
|
|
61
|
+
if (needsValue.type === "YAMLScalar") {
|
|
62
|
+
const jobId = getScalarStringValue(needsValue);
|
|
63
|
+
if (jobId !== null) {
|
|
64
|
+
directNeeds.add(jobId);
|
|
65
|
+
}
|
|
66
|
+
return directNeeds;
|
|
67
|
+
}
|
|
68
|
+
if (needsValue.type !== "YAMLSequence") {
|
|
69
|
+
return directNeeds;
|
|
70
|
+
}
|
|
71
|
+
for (const entry of needsValue.entries) {
|
|
72
|
+
const jobId = getScalarStringValue(entry);
|
|
73
|
+
if (jobId !== null) {
|
|
74
|
+
directNeeds.add(jobId);
|
|
75
|
+
}
|
|
76
|
+
}
|
|
77
|
+
return directNeeds;
|
|
78
|
+
};
|
|
79
|
+
/** Rule implementation for validating job output references. */
|
|
80
|
+
const rule = {
|
|
81
|
+
create(context) {
|
|
82
|
+
return {
|
|
83
|
+
Program() {
|
|
84
|
+
const root = getWorkflowRoot(context);
|
|
85
|
+
if (root === null) {
|
|
86
|
+
return;
|
|
87
|
+
}
|
|
88
|
+
const jobs = getWorkflowJobs(root);
|
|
89
|
+
const declaredOutputsByJobId = new Map(jobs.map((job) => [
|
|
90
|
+
job.id,
|
|
91
|
+
getDeclaredJobOutputNames(job.mapping),
|
|
92
|
+
]));
|
|
93
|
+
const onMapping = getMappingValueAsMapping(root, "on");
|
|
94
|
+
const workflowCallMapping = onMapping === null
|
|
95
|
+
? null
|
|
96
|
+
: getMappingValueAsMapping(onMapping, "workflow_call");
|
|
97
|
+
const workflowCallOutputsMapping = workflowCallMapping === null
|
|
98
|
+
? null
|
|
99
|
+
: getMappingValueAsMapping(workflowCallMapping, "outputs");
|
|
100
|
+
if (workflowCallOutputsMapping !== null) {
|
|
101
|
+
for (const pair of workflowCallOutputsMapping.pairs) {
|
|
102
|
+
const reusableOutputName = getScalarStringValue(pair.key);
|
|
103
|
+
const reusableOutputMapping = unwrapYamlValue(pair.value);
|
|
104
|
+
if (reusableOutputName === null ||
|
|
105
|
+
reusableOutputMapping?.type !== "YAMLMapping") {
|
|
106
|
+
continue;
|
|
107
|
+
}
|
|
108
|
+
const valuePair = getMappingPair(reusableOutputMapping, "value");
|
|
109
|
+
visitStringScalars(valuePair?.value ?? null, (node, value) => {
|
|
110
|
+
for (const match of value.matchAll(jobsOutputReferencePattern)) {
|
|
111
|
+
const reference = match[0];
|
|
112
|
+
const jobId = match.groups?.["jobId"];
|
|
113
|
+
const outputName = match.groups?.["outputName"];
|
|
114
|
+
if (jobId === undefined ||
|
|
115
|
+
outputName === undefined) {
|
|
116
|
+
continue;
|
|
117
|
+
}
|
|
118
|
+
const declaredOutputNames = declaredOutputsByJobId.get(jobId);
|
|
119
|
+
if (declaredOutputNames === undefined) {
|
|
120
|
+
context.report({
|
|
121
|
+
data: {
|
|
122
|
+
jobId,
|
|
123
|
+
reference,
|
|
124
|
+
reusableOutputName,
|
|
125
|
+
},
|
|
126
|
+
messageId: "unknownReusableWorkflowJob",
|
|
127
|
+
node: node,
|
|
128
|
+
});
|
|
129
|
+
continue;
|
|
130
|
+
}
|
|
131
|
+
if (declaredOutputNames.has(outputName)) {
|
|
132
|
+
continue;
|
|
133
|
+
}
|
|
134
|
+
context.report({
|
|
135
|
+
data: {
|
|
136
|
+
jobId,
|
|
137
|
+
outputName,
|
|
138
|
+
reference,
|
|
139
|
+
reusableOutputName,
|
|
140
|
+
},
|
|
141
|
+
messageId: "unknownReusableWorkflowJobOutput",
|
|
142
|
+
node: node,
|
|
143
|
+
});
|
|
144
|
+
}
|
|
145
|
+
});
|
|
146
|
+
}
|
|
147
|
+
}
|
|
148
|
+
for (const job of jobs) {
|
|
149
|
+
const directNeedsJobIds = getDirectNeedsJobIds(job.mapping);
|
|
150
|
+
visitStringScalars(job.mapping, (node, value) => {
|
|
151
|
+
for (const match of value.matchAll(needsOutputReferencePattern)) {
|
|
152
|
+
const reference = match[0];
|
|
153
|
+
const neededJobId = match.groups?.["neededJobId"];
|
|
154
|
+
const outputName = match.groups?.["outputName"];
|
|
155
|
+
if (neededJobId === undefined ||
|
|
156
|
+
outputName === undefined) {
|
|
157
|
+
continue;
|
|
158
|
+
}
|
|
159
|
+
const declaredOutputNames = declaredOutputsByJobId.get(neededJobId);
|
|
160
|
+
if (declaredOutputNames === undefined) {
|
|
161
|
+
context.report({
|
|
162
|
+
data: {
|
|
163
|
+
currentJobId: job.id,
|
|
164
|
+
neededJobId,
|
|
165
|
+
reference,
|
|
166
|
+
},
|
|
167
|
+
messageId: "unknownNeedsJob",
|
|
168
|
+
node: node,
|
|
169
|
+
});
|
|
170
|
+
continue;
|
|
171
|
+
}
|
|
172
|
+
if (!directNeedsJobIds.has(neededJobId)) {
|
|
173
|
+
context.report({
|
|
174
|
+
data: {
|
|
175
|
+
currentJobId: job.id,
|
|
176
|
+
neededJobId,
|
|
177
|
+
reference,
|
|
178
|
+
},
|
|
179
|
+
messageId: "missingNeedsDependency",
|
|
180
|
+
node: node,
|
|
181
|
+
});
|
|
182
|
+
continue;
|
|
183
|
+
}
|
|
184
|
+
if (declaredOutputNames.has(outputName)) {
|
|
185
|
+
continue;
|
|
186
|
+
}
|
|
187
|
+
context.report({
|
|
188
|
+
data: {
|
|
189
|
+
currentJobId: job.id,
|
|
190
|
+
neededJobId,
|
|
191
|
+
outputName,
|
|
192
|
+
reference,
|
|
193
|
+
},
|
|
194
|
+
messageId: "unknownNeedsOutput",
|
|
195
|
+
node: node,
|
|
196
|
+
});
|
|
197
|
+
}
|
|
198
|
+
});
|
|
199
|
+
}
|
|
200
|
+
},
|
|
201
|
+
};
|
|
202
|
+
},
|
|
203
|
+
meta: {
|
|
204
|
+
docs: {
|
|
205
|
+
configs: [
|
|
206
|
+
"github-actions.configs.all",
|
|
207
|
+
"github-actions.configs.recommended",
|
|
208
|
+
"github-actions.configs.strict",
|
|
209
|
+
],
|
|
210
|
+
description: "disallow `needs.*.outputs.*` and reusable-workflow `jobs.*.outputs.*` references that point at undeclared jobs or outputs.",
|
|
211
|
+
recommended: true,
|
|
212
|
+
requiresTypeChecking: false,
|
|
213
|
+
ruleId: "R037",
|
|
214
|
+
ruleNumber: 37,
|
|
215
|
+
url: "https://nick2bad4u.github.io/eslint-plugin-github-actions-2/docs/rules/no-unknown-job-output-reference",
|
|
216
|
+
},
|
|
217
|
+
messages: {
|
|
218
|
+
missingNeedsDependency: "Job '{{currentJobId}}' references `{{reference}}`, but job '{{neededJobId}}' is not listed in that job's direct `needs` dependencies.",
|
|
219
|
+
unknownNeedsJob: "Job '{{currentJobId}}' references `{{reference}}`, but job '{{neededJobId}}' is not declared in this workflow.",
|
|
220
|
+
unknownNeedsOutput: "Job '{{currentJobId}}' references `{{reference}}`, but job '{{neededJobId}}' does not declare output '{{outputName}}' under `jobs.{{neededJobId}}.outputs`.",
|
|
221
|
+
unknownReusableWorkflowJob: "Reusable workflow output '{{reusableOutputName}}' references `{{reference}}`, but job '{{jobId}}' is not declared in this workflow.",
|
|
222
|
+
unknownReusableWorkflowJobOutput: "Reusable workflow output '{{reusableOutputName}}' references `{{reference}}`, but job '{{jobId}}' does not declare output '{{outputName}}' under `jobs.{{jobId}}.outputs`.",
|
|
223
|
+
},
|
|
224
|
+
schema: [],
|
|
225
|
+
type: "problem",
|
|
226
|
+
},
|
|
227
|
+
};
|
|
228
|
+
export default rule;
|
|
229
|
+
//# sourceMappingURL=no-unknown-job-output-reference.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"no-unknown-job-output-reference.js","sourceRoot":"","sources":["../../src/rules/no-unknown-job-output-reference.ts"],"names":[],"mappings":"AAOA,OAAO,EACH,cAAc,EACd,wBAAwB,EACxB,oBAAoB,EACpB,eAAe,EACf,eAAe,EACf,eAAe,GAClB,MAAM,+BAA+B,CAAC;AAEvC;;;GAGG;AACH,MAAM,2BAA2B,GAC7B,kFAAkF,CAAC;AAEvF;;;GAGG;AACH,MAAM,0BAA0B,GAC5B,2EAA2E,CAAC;AAEhF,kEAAkE;AAClE,MAAM,kBAAkB,GAAG,CACvB,IAAyD,EACzD,OAAgE,EAC5D,EAAE;IACN,MAAM,aAAa,GAAG,eAAe,CACjC,IAAiD,CACpD,CAAC;IAEF,IAAI,aAAa,KAAK,IAAI,EAAE,CAAC;QACzB,OAAO;IACX,CAAC;IAED,IAAI,aAAa,CAAC,IAAI,KAAK,YAAY,EAAE,CAAC;QACtC,MAAM,KAAK,GAAG,oBAAoB,CAAC,aAAa,CAAC,CAAC;QAElD,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;YACjB,OAAO,CAAC,aAAa,EAAE,KAAK,CAAC,CAAC;QAClC,CAAC;QAED,OAAO;IACX,CAAC;IAED,IAAI,aAAa,CAAC,IAAI,KAAK,cAAc,EAAE,CAAC;QACxC,KAAK,MAAM,KAAK,IAAI,aAAa,CAAC,OAAO,EAAE,CAAC;YACxC,kBAAkB,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;QACvC,CAAC;QAED,OAAO;IACX,CAAC;IAED,IAAI,aAAa,CAAC,IAAI,KAAK,aAAa,EAAE,CAAC;QACvC,OAAO;IACX,CAAC;IAED,KAAK,MAAM,IAAI,IAAI,aAAa,CAAC,KAAK,EAAE,CAAC;QACrC,kBAAkB,CAAC,IAAI,CAAC,KAAK,IAAI,IAAI,EAAE,OAAO,CAAC,CAAC;IACpD,CAAC;AACL,CAAC,CAAC;AAEF,2DAA2D;AAC3D,MAAM,yBAAyB,GAAG,CAC9B,UAAqC,EAClB,EAAE;IACrB,MAAM,cAAc,GAAG,wBAAwB,CAAC,UAAU,EAAE,SAAS,CAAC,CAAC;IACvE,MAAM,WAAW,GAAG,IAAI,GAAG,EAAU,CAAC;IAEtC,IAAI,cAAc,KAAK,IAAI,EAAE,CAAC;QAC1B,OAAO,WAAW,CAAC;IACvB,CAAC;IAED,KAAK,MAAM,IAAI,IAAI,cAAc,CAAC,KAAK,EAAE,CAAC;QACtC,MAAM,UAAU,GAAG,oBAAoB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAElD,IAAI,UAAU,KAAK,IAAI,EAAE,CAAC;YACtB,WAAW,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;QAChC,CAAC;IACL,CAAC;IAED,OAAO,WAAW,CAAC;AACvB,CAAC,CAAC;AAEF,oEAAoE;AACpE,MAAM,oBAAoB,GAAG,CACzB,UAAqC,EAClB,EAAE;IACrB,MAAM,SAAS,GAAG,cAAc,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;IACtD,MAAM,UAAU,GAAG,eAAe,CAAC,SAAS,EAAE,KAAK,IAAI,IAAI,CAAC,CAAC;IAC7D,MAAM,WAAW,GAAG,IAAI,GAAG,EAAU,CAAC;IAEtC,IAAI,UAAU,KAAK,IAAI,EAAE,CAAC;QACtB,OAAO,WAAW,CAAC;IACvB,CAAC;IAED,IAAI,UAAU,CAAC,IAAI,KAAK,YAAY,EAAE,CAAC;QACnC,MAAM,KAAK,GAAG,oBAAoB,CAAC,UAAU,CAAC,CAAC;QAE/C,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;YACjB,WAAW,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;QAC3B,CAAC;QAED,OAAO,WAAW,CAAC;IACvB,CAAC;IAED,IAAI,UAAU,CAAC,IAAI,KAAK,cAAc,EAAE,CAAC;QACrC,OAAO,WAAW,CAAC;IACvB,CAAC;IAED,KAAK,MAAM,KAAK,IAAI,UAAU,CAAC,OAAO,EAAE,CAAC;QACrC,MAAM,KAAK,GAAG,oBAAoB,CAAC,KAAK,CAAC,CAAC;QAE1C,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;YACjB,WAAW,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;QAC3B,CAAC;IACL,CAAC;IAED,OAAO,WAAW,CAAC;AACvB,CAAC,CAAC;AAEF,gEAAgE;AAChE,MAAM,IAAI,GAAoB;IAC1B,MAAM,CAAC,OAAO;QACV,OAAO;YACH,OAAO;gBACH,MAAM,IAAI,GAAG,eAAe,CAAC,OAAO,CAAC,CAAC;gBAEtC,IAAI,IAAI,KAAK,IAAI,EAAE,CAAC;oBAChB,OAAO;gBACX,CAAC;gBAED,MAAM,IAAI,GAAG,eAAe,CAAC,IAAI,CAAC,CAAC;gBACnC,MAAM,sBAAsB,GAAG,IAAI,GAAG,CAClC,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC;oBACd,GAAG,CAAC,EAAE;oBACN,yBAAyB,CAAC,GAAG,CAAC,OAAO,CAAC;iBACzC,CAAC,CACL,CAAC;gBAEF,MAAM,SAAS,GAAG,wBAAwB,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;gBACvD,MAAM,mBAAmB,GACrB,SAAS,KAAK,IAAI;oBACd,CAAC,CAAC,IAAI;oBACN,CAAC,CAAC,wBAAwB,CAAC,SAAS,EAAE,eAAe,CAAC,CAAC;gBAC/D,MAAM,0BAA0B,GAC5B,mBAAmB,KAAK,IAAI;oBACxB,CAAC,CAAC,IAAI;oBACN,CAAC,CAAC,wBAAwB,CACpB,mBAAmB,EACnB,SAAS,CACZ,CAAC;gBAEZ,IAAI,0BAA0B,KAAK,IAAI,EAAE,CAAC;oBACtC,KAAK,MAAM,IAAI,IAAI,0BAA0B,CAAC,KAAK,EAAE,CAAC;wBAClD,MAAM,kBAAkB,GAAG,oBAAoB,CAC3C,IAAI,CAAC,GAAG,CACX,CAAC;wBACF,MAAM,qBAAqB,GAAG,eAAe,CACzC,IAAI,CAAC,KAAK,CACb,CAAC;wBAEF,IACI,kBAAkB,KAAK,IAAI;4BAC3B,qBAAqB,EAAE,IAAI,KAAK,aAAa,EAC/C,CAAC;4BACC,SAAS;wBACb,CAAC;wBAED,MAAM,SAAS,GAAG,cAAc,CAC5B,qBAAqB,EACrB,OAAO,CACV,CAAC;wBAEF,kBAAkB,CACd,SAAS,EAAE,KAAK,IAAI,IAAI,EACxB,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE;4BACZ,KAAK,MAAM,KAAK,IAAI,KAAK,CAAC,QAAQ,CAC9B,0BAA0B,CAC7B,EAAE,CAAC;gCACA,MAAM,SAAS,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;gCAC3B,MAAM,KAAK,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,OAAO,CAAC,CAAC;gCACtC,MAAM,UAAU,GACZ,KAAK,CAAC,MAAM,EAAE,CAAC,YAAY,CAAC,CAAC;gCAEjC,IACI,KAAK,KAAK,SAAS;oCACnB,UAAU,KAAK,SAAS,EAC1B,CAAC;oCACC,SAAS;gCACb,CAAC;gCAED,MAAM,mBAAmB,GACrB,sBAAsB,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;gCAEtC,IAAI,mBAAmB,KAAK,SAAS,EAAE,CAAC;oCACpC,OAAO,CAAC,MAAM,CAAC;wCACX,IAAI,EAAE;4CACF,KAAK;4CACL,SAAS;4CACT,kBAAkB;yCACrB;wCACD,SAAS,EACL,4BAA4B;wCAChC,IAAI,EAAE,IAA4B;qCACrC,CAAC,CAAC;oCAEH,SAAS;gCACb,CAAC;gCAED,IAAI,mBAAmB,CAAC,GAAG,CAAC,UAAU,CAAC,EAAE,CAAC;oCACtC,SAAS;gCACb,CAAC;gCAED,OAAO,CAAC,MAAM,CAAC;oCACX,IAAI,EAAE;wCACF,KAAK;wCACL,UAAU;wCACV,SAAS;wCACT,kBAAkB;qCACrB;oCACD,SAAS,EACL,kCAAkC;oCACtC,IAAI,EAAE,IAA4B;iCACrC,CAAC,CAAC;4BACP,CAAC;wBACL,CAAC,CACJ,CAAC;oBACN,CAAC;gBACL,CAAC;gBAED,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;oBACrB,MAAM,iBAAiB,GAAG,oBAAoB,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;oBAE5D,kBAAkB,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE;wBAC5C,KAAK,MAAM,KAAK,IAAI,KAAK,CAAC,QAAQ,CAC9B,2BAA2B,CAC9B,EAAE,CAAC;4BACA,MAAM,SAAS,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;4BAC3B,MAAM,WAAW,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,aAAa,CAAC,CAAC;4BAClD,MAAM,UAAU,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,YAAY,CAAC,CAAC;4BAEhD,IACI,WAAW,KAAK,SAAS;gCACzB,UAAU,KAAK,SAAS,EAC1B,CAAC;gCACC,SAAS;4BACb,CAAC;4BAED,MAAM,mBAAmB,GACrB,sBAAsB,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;4BAE5C,IAAI,mBAAmB,KAAK,SAAS,EAAE,CAAC;gCACpC,OAAO,CAAC,MAAM,CAAC;oCACX,IAAI,EAAE;wCACF,YAAY,EAAE,GAAG,CAAC,EAAE;wCACpB,WAAW;wCACX,SAAS;qCACZ;oCACD,SAAS,EAAE,iBAAiB;oCAC5B,IAAI,EAAE,IAA4B;iCACrC,CAAC,CAAC;gCAEH,SAAS;4BACb,CAAC;4BAED,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,WAAW,CAAC,EAAE,CAAC;gCACtC,OAAO,CAAC,MAAM,CAAC;oCACX,IAAI,EAAE;wCACF,YAAY,EAAE,GAAG,CAAC,EAAE;wCACpB,WAAW;wCACX,SAAS;qCACZ;oCACD,SAAS,EAAE,wBAAwB;oCACnC,IAAI,EAAE,IAA4B;iCACrC,CAAC,CAAC;gCAEH,SAAS;4BACb,CAAC;4BAED,IAAI,mBAAmB,CAAC,GAAG,CAAC,UAAU,CAAC,EAAE,CAAC;gCACtC,SAAS;4BACb,CAAC;4BAED,OAAO,CAAC,MAAM,CAAC;gCACX,IAAI,EAAE;oCACF,YAAY,EAAE,GAAG,CAAC,EAAE;oCACpB,WAAW;oCACX,UAAU;oCACV,SAAS;iCACZ;gCACD,SAAS,EAAE,oBAAoB;gCAC/B,IAAI,EAAE,IAA4B;6BACrC,CAAC,CAAC;wBACP,CAAC;oBACL,CAAC,CAAC,CAAC;gBACP,CAAC;YACL,CAAC;SACJ,CAAC;IACN,CAAC;IACD,IAAI,EAAE;QACF,IAAI,EAAE;YACF,OAAO,EAAE;gBACL,4BAA4B;gBAC5B,oCAAoC;gBACpC,+BAA+B;aAClC;YACD,WAAW,EACP,4HAA4H;YAChI,WAAW,EAAE,IAAI;YACjB,oBAAoB,EAAE,KAAK;YAC3B,MAAM,EAAE,MAAM;YACd,UAAU,EAAE,EAAE;YACd,GAAG,EAAE,wGAAwG;SAChH;QACD,QAAQ,EAAE;YACN,sBAAsB,EAClB,uIAAuI;YAC3I,eAAe,EACX,gHAAgH;YACpH,kBAAkB,EACd,6JAA6J;YACjK,0BAA0B,EACtB,qIAAqI;YACzI,gCAAgC,EAC5B,4KAA4K;SACnL;QACD,MAAM,EAAE,EAAE;QACV,IAAI,EAAE,SAAS;KACG;CACzB,CAAC;AAEF,eAAe,IAAI,CAAC"}
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @packageDocumentation
|
|
3
|
+
* Disallow references to undefined or not-yet-available steps.
|
|
4
|
+
*/
|
|
5
|
+
import type { Rule } from "eslint";
|
|
6
|
+
/** Rule implementation for validating step context references. */
|
|
7
|
+
declare const rule: Rule.RuleModule;
|
|
8
|
+
export default rule;
|
|
9
|
+
//# sourceMappingURL=no-unknown-step-reference.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"no-unknown-step-reference.d.ts","sourceRoot":"","sources":["../../src/rules/no-unknown-step-reference.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AA0GnC,kEAAkE;AAClE,QAAA,MAAM,IAAI,EAAE,IAAI,CAAC,UA0FhB,CAAC;AAEF,eAAe,IAAI,CAAC"}
|
|
@@ -0,0 +1,133 @@
|
|
|
1
|
+
import { getMappingPair, getMappingValueAsSequence, getScalarStringValue, getWorkflowJobs, getWorkflowRoot, unwrapYamlValue, } from "../_internal/workflow-yaml.js";
|
|
2
|
+
/** Step context references using property dereference syntax. */
|
|
3
|
+
const stepReferencePattern = /steps\.(?<stepId>[A-Z_a-z][\w-]*)\.(?:outputs\.[A-Z_a-z][\w-]*|conclusion|outcome)/g;
|
|
4
|
+
/**
|
|
5
|
+
* Visit every string scalar in a job, tracking the current step index when
|
|
6
|
+
* applicable.
|
|
7
|
+
*/
|
|
8
|
+
const visitJobStringScalars = (node, visitor, currentStepIndex = null) => {
|
|
9
|
+
const unwrappedNode = unwrapYamlValue(node);
|
|
10
|
+
if (unwrappedNode === null) {
|
|
11
|
+
return;
|
|
12
|
+
}
|
|
13
|
+
if (unwrappedNode.type === "YAMLScalar") {
|
|
14
|
+
const value = getScalarStringValue(unwrappedNode);
|
|
15
|
+
if (value !== null) {
|
|
16
|
+
visitor(unwrappedNode, value, currentStepIndex);
|
|
17
|
+
}
|
|
18
|
+
return;
|
|
19
|
+
}
|
|
20
|
+
if (unwrappedNode.type === "YAMLSequence") {
|
|
21
|
+
for (const entry of unwrappedNode.entries) {
|
|
22
|
+
visitJobStringScalars(entry, visitor, currentStepIndex);
|
|
23
|
+
}
|
|
24
|
+
return;
|
|
25
|
+
}
|
|
26
|
+
if (unwrappedNode.type !== "YAMLMapping") {
|
|
27
|
+
return;
|
|
28
|
+
}
|
|
29
|
+
const stepsSequence = getMappingValueAsSequence(unwrappedNode, "steps");
|
|
30
|
+
if (stepsSequence !== null) {
|
|
31
|
+
for (const [stepIndex, entry] of stepsSequence.entries.entries()) {
|
|
32
|
+
visitJobStringScalars(entry, visitor, stepIndex);
|
|
33
|
+
}
|
|
34
|
+
}
|
|
35
|
+
for (const pair of unwrappedNode.pairs) {
|
|
36
|
+
if (getScalarStringValue(pair.key) === "steps") {
|
|
37
|
+
continue;
|
|
38
|
+
}
|
|
39
|
+
visitJobStringScalars(pair.value ?? null, visitor, currentStepIndex);
|
|
40
|
+
}
|
|
41
|
+
};
|
|
42
|
+
/** Collect the first declared index for each step id in a job. */
|
|
43
|
+
const getStepIndexById = (jobMapping) => {
|
|
44
|
+
const stepsSequence = getMappingValueAsSequence(jobMapping, "steps");
|
|
45
|
+
const stepIndexById = new Map();
|
|
46
|
+
if (stepsSequence === null) {
|
|
47
|
+
return stepIndexById;
|
|
48
|
+
}
|
|
49
|
+
for (const [stepIndex, entry] of stepsSequence.entries.entries()) {
|
|
50
|
+
const stepMapping = unwrapYamlValue(entry);
|
|
51
|
+
if (stepMapping?.type !== "YAMLMapping") {
|
|
52
|
+
continue;
|
|
53
|
+
}
|
|
54
|
+
const stepId = getScalarStringValue(getMappingPair(stepMapping, "id")?.value ?? null);
|
|
55
|
+
if (stepId !== null && !stepIndexById.has(stepId)) {
|
|
56
|
+
stepIndexById.set(stepId, stepIndex);
|
|
57
|
+
}
|
|
58
|
+
}
|
|
59
|
+
return stepIndexById;
|
|
60
|
+
};
|
|
61
|
+
/** Rule implementation for validating step context references. */
|
|
62
|
+
const rule = {
|
|
63
|
+
create(context) {
|
|
64
|
+
return {
|
|
65
|
+
Program() {
|
|
66
|
+
const root = getWorkflowRoot(context);
|
|
67
|
+
if (root === null) {
|
|
68
|
+
return;
|
|
69
|
+
}
|
|
70
|
+
for (const job of getWorkflowJobs(root)) {
|
|
71
|
+
const stepIndexById = getStepIndexById(job.mapping);
|
|
72
|
+
visitJobStringScalars(job.mapping, (node, value, currentStepIndex) => {
|
|
73
|
+
for (const match of value.matchAll(stepReferencePattern)) {
|
|
74
|
+
const reference = match[0];
|
|
75
|
+
const stepId = match.groups?.["stepId"];
|
|
76
|
+
if (stepId === undefined) {
|
|
77
|
+
continue;
|
|
78
|
+
}
|
|
79
|
+
const referencedStepIndex = stepIndexById.get(stepId);
|
|
80
|
+
if (referencedStepIndex === undefined) {
|
|
81
|
+
context.report({
|
|
82
|
+
data: {
|
|
83
|
+
jobId: job.id,
|
|
84
|
+
reference,
|
|
85
|
+
stepId,
|
|
86
|
+
},
|
|
87
|
+
messageId: "unknownStepReference",
|
|
88
|
+
node: node,
|
|
89
|
+
});
|
|
90
|
+
continue;
|
|
91
|
+
}
|
|
92
|
+
if (currentStepIndex === null ||
|
|
93
|
+
referencedStepIndex < currentStepIndex) {
|
|
94
|
+
continue;
|
|
95
|
+
}
|
|
96
|
+
context.report({
|
|
97
|
+
data: {
|
|
98
|
+
jobId: job.id,
|
|
99
|
+
reference,
|
|
100
|
+
stepId,
|
|
101
|
+
},
|
|
102
|
+
messageId: "stepReferenceBeforeAvailability",
|
|
103
|
+
node: node,
|
|
104
|
+
});
|
|
105
|
+
}
|
|
106
|
+
});
|
|
107
|
+
}
|
|
108
|
+
},
|
|
109
|
+
};
|
|
110
|
+
},
|
|
111
|
+
meta: {
|
|
112
|
+
docs: {
|
|
113
|
+
configs: [
|
|
114
|
+
"github-actions.configs.all",
|
|
115
|
+
"github-actions.configs.strict",
|
|
116
|
+
],
|
|
117
|
+
description: "disallow `steps.<id>.*` references that target a missing step id or a step that has not run yet.",
|
|
118
|
+
recommended: false,
|
|
119
|
+
requiresTypeChecking: false,
|
|
120
|
+
ruleId: "R038",
|
|
121
|
+
ruleNumber: 38,
|
|
122
|
+
url: "https://nick2bad4u.github.io/eslint-plugin-github-actions-2/docs/rules/no-unknown-step-reference",
|
|
123
|
+
},
|
|
124
|
+
messages: {
|
|
125
|
+
stepReferenceBeforeAvailability: "Job '{{jobId}}' references `{{reference}}` before step '{{stepId}}' has run. The `steps` context only contains prior steps in the same job.",
|
|
126
|
+
unknownStepReference: "Job '{{jobId}}' references `{{reference}}`, but no step with `id: {{stepId}}` exists in that job.",
|
|
127
|
+
},
|
|
128
|
+
schema: [],
|
|
129
|
+
type: "problem",
|
|
130
|
+
},
|
|
131
|
+
};
|
|
132
|
+
export default rule;
|
|
133
|
+
//# sourceMappingURL=no-unknown-step-reference.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"no-unknown-step-reference.js","sourceRoot":"","sources":["../../src/rules/no-unknown-step-reference.ts"],"names":[],"mappings":"AAOA,OAAO,EACH,cAAc,EACd,yBAAyB,EACzB,oBAAoB,EACpB,eAAe,EACf,eAAe,EACf,eAAe,GAClB,MAAM,+BAA+B,CAAC;AAEvC,iEAAiE;AACjE,MAAM,oBAAoB,GACtB,qFAAqF,CAAC;AAE1F;;;GAGG;AACH,MAAM,qBAAqB,GAAG,CAC1B,IAAyD,EACzD,OAIS,EACT,mBAAkC,IAAI,EAClC,EAAE;IACN,MAAM,aAAa,GAAG,eAAe,CACjC,IAAiD,CACpD,CAAC;IAEF,IAAI,aAAa,KAAK,IAAI,EAAE,CAAC;QACzB,OAAO;IACX,CAAC;IAED,IAAI,aAAa,CAAC,IAAI,KAAK,YAAY,EAAE,CAAC;QACtC,MAAM,KAAK,GAAG,oBAAoB,CAAC,aAAa,CAAC,CAAC;QAElD,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;YACjB,OAAO,CAAC,aAAa,EAAE,KAAK,EAAE,gBAAgB,CAAC,CAAC;QACpD,CAAC;QAED,OAAO;IACX,CAAC;IAED,IAAI,aAAa,CAAC,IAAI,KAAK,cAAc,EAAE,CAAC;QACxC,KAAK,MAAM,KAAK,IAAI,aAAa,CAAC,OAAO,EAAE,CAAC;YACxC,qBAAqB,CAAC,KAAK,EAAE,OAAO,EAAE,gBAAgB,CAAC,CAAC;QAC5D,CAAC;QAED,OAAO;IACX,CAAC;IAED,IAAI,aAAa,CAAC,IAAI,KAAK,aAAa,EAAE,CAAC;QACvC,OAAO;IACX,CAAC;IAED,MAAM,aAAa,GAAG,yBAAyB,CAAC,aAAa,EAAE,OAAO,CAAC,CAAC;IAExE,IAAI,aAAa,KAAK,IAAI,EAAE,CAAC;QACzB,KAAK,MAAM,CAAC,SAAS,EAAE,KAAK,CAAC,IAAI,aAAa,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC;YAC/D,qBAAqB,CAAC,KAAK,EAAE,OAAO,EAAE,SAAS,CAAC,CAAC;QACrD,CAAC;IACL,CAAC;IAED,KAAK,MAAM,IAAI,IAAI,aAAa,CAAC,KAAK,EAAE,CAAC;QACrC,IAAI,oBAAoB,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,OAAO,EAAE,CAAC;YAC7C,SAAS;QACb,CAAC;QAED,qBAAqB,CAAC,IAAI,CAAC,KAAK,IAAI,IAAI,EAAE,OAAO,EAAE,gBAAgB,CAAC,CAAC;IACzE,CAAC;AACL,CAAC,CAAC;AAEF,kEAAkE;AAClE,MAAM,gBAAgB,GAAG,CACrB,UAAqC,EACV,EAAE;IAC7B,MAAM,aAAa,GAAG,yBAAyB,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;IACrE,MAAM,aAAa,GAAG,IAAI,GAAG,EAAkB,CAAC;IAEhD,IAAI,aAAa,KAAK,IAAI,EAAE,CAAC;QACzB,OAAO,aAAa,CAAC;IACzB,CAAC;IAED,KAAK,MAAM,CAAC,SAAS,EAAE,KAAK,CAAC,IAAI,aAAa,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC;QAC/D,MAAM,WAAW,GAAG,eAAe,CAAC,KAAK,CAAC,CAAC;QAE3C,IAAI,WAAW,EAAE,IAAI,KAAK,aAAa,EAAE,CAAC;YACtC,SAAS;QACb,CAAC;QAED,MAAM,MAAM,GAAG,oBAAoB,CAC/B,cAAc,CAAC,WAAW,EAAE,IAAI,CAAC,EAAE,KAAK,IAAI,IAAI,CACnD,CAAC;QAEF,IAAI,MAAM,KAAK,IAAI,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC;YAChD,aAAa,CAAC,GAAG,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;QACzC,CAAC;IACL,CAAC;IAED,OAAO,aAAa,CAAC;AACzB,CAAC,CAAC;AAEF,kEAAkE;AAClE,MAAM,IAAI,GAAoB;IAC1B,MAAM,CAAC,OAAO;QACV,OAAO;YACH,OAAO;gBACH,MAAM,IAAI,GAAG,eAAe,CAAC,OAAO,CAAC,CAAC;gBAEtC,IAAI,IAAI,KAAK,IAAI,EAAE,CAAC;oBAChB,OAAO;gBACX,CAAC;gBAED,KAAK,MAAM,GAAG,IAAI,eAAe,CAAC,IAAI,CAAC,EAAE,CAAC;oBACtC,MAAM,aAAa,GAAG,gBAAgB,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;oBAEpD,qBAAqB,CACjB,GAAG,CAAC,OAAO,EACX,CAAC,IAAI,EAAE,KAAK,EAAE,gBAAgB,EAAE,EAAE;wBAC9B,KAAK,MAAM,KAAK,IAAI,KAAK,CAAC,QAAQ,CAC9B,oBAAoB,CACvB,EAAE,CAAC;4BACA,MAAM,SAAS,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;4BAC3B,MAAM,MAAM,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,CAAC;4BAExC,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;gCACvB,SAAS;4BACb,CAAC;4BAED,MAAM,mBAAmB,GACrB,aAAa,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;4BAE9B,IAAI,mBAAmB,KAAK,SAAS,EAAE,CAAC;gCACpC,OAAO,CAAC,MAAM,CAAC;oCACX,IAAI,EAAE;wCACF,KAAK,EAAE,GAAG,CAAC,EAAE;wCACb,SAAS;wCACT,MAAM;qCACT;oCACD,SAAS,EAAE,sBAAsB;oCACjC,IAAI,EAAE,IAA4B;iCACrC,CAAC,CAAC;gCAEH,SAAS;4BACb,CAAC;4BAED,IACI,gBAAgB,KAAK,IAAI;gCACzB,mBAAmB,GAAG,gBAAgB,EACxC,CAAC;gCACC,SAAS;4BACb,CAAC;4BAED,OAAO,CAAC,MAAM,CAAC;gCACX,IAAI,EAAE;oCACF,KAAK,EAAE,GAAG,CAAC,EAAE;oCACb,SAAS;oCACT,MAAM;iCACT;gCACD,SAAS,EACL,iCAAiC;gCACrC,IAAI,EAAE,IAA4B;6BACrC,CAAC,CAAC;wBACP,CAAC;oBACL,CAAC,CACJ,CAAC;gBACN,CAAC;YACL,CAAC;SACJ,CAAC;IACN,CAAC;IACD,IAAI,EAAE;QACF,IAAI,EAAE;YACF,OAAO,EAAE;gBACL,4BAA4B;gBAC5B,+BAA+B;aAClC;YACD,WAAW,EACP,kGAAkG;YACtG,WAAW,EAAE,KAAK;YAClB,oBAAoB,EAAE,KAAK;YAC3B,MAAM,EAAE,MAAM;YACd,UAAU,EAAE,EAAE;YACd,GAAG,EAAE,kGAAkG;SAC1G;QACD,QAAQ,EAAE;YACN,+BAA+B,EAC3B,6IAA6I;YACjJ,oBAAoB,EAChB,mGAAmG;SAC1G;QACD,MAAM,EAAE,EAAE;QACV,IAAI,EAAE,SAAS;KACG;CACzB,CAAC;AAEF,eAAe,IAAI,CAAC"}
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @packageDocumentation
|
|
3
|
+
* Disallow directly interpolating untrusted event inputs inside `run` steps.
|
|
4
|
+
*/
|
|
5
|
+
import type { Rule } from "eslint";
|
|
6
|
+
/** Rule implementation for disallowing unsafe direct interpolation in `run`. */
|
|
7
|
+
declare const rule: Rule.RuleModule;
|
|
8
|
+
export default rule;
|
|
9
|
+
//# sourceMappingURL=no-untrusted-input-in-run.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"no-untrusted-input-in-run.d.ts","sourceRoot":"","sources":["../../src/rules/no-untrusted-input-in-run.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AA+DnC,gFAAgF;AAChF,QAAA,MAAM,IAAI,EAAE,IAAI,CAAC,UA8EhB,CAAC;AAEF,eAAe,IAAI,CAAC"}
|
|
@@ -0,0 +1,115 @@
|
|
|
1
|
+
import { getMappingPair, getMappingValueAsSequence, getScalarStringValue, getWorkflowJobs, getWorkflowRoot, unwrapYamlValue, } from "../_internal/workflow-yaml.js";
|
|
2
|
+
/**
|
|
3
|
+
* Untrusted workflow-expression sources that should not be embedded directly in
|
|
4
|
+
* `run`.
|
|
5
|
+
*/
|
|
6
|
+
const untrustedRunExpressionSources = [
|
|
7
|
+
{
|
|
8
|
+
fragments: [
|
|
9
|
+
"github.event.pull_request.body",
|
|
10
|
+
"github.event.pull_request.title",
|
|
11
|
+
],
|
|
12
|
+
source: "pull request title/body",
|
|
13
|
+
},
|
|
14
|
+
{
|
|
15
|
+
fragments: ["github.event.issue.body", "github.event.issue.title"],
|
|
16
|
+
source: "issue title/body",
|
|
17
|
+
},
|
|
18
|
+
{
|
|
19
|
+
fragments: ["github.event.comment.body"],
|
|
20
|
+
source: "comment body",
|
|
21
|
+
},
|
|
22
|
+
{
|
|
23
|
+
fragments: ["github.event.review.body"],
|
|
24
|
+
source: "review body",
|
|
25
|
+
},
|
|
26
|
+
{
|
|
27
|
+
fragments: [
|
|
28
|
+
"github.event.discussion.body",
|
|
29
|
+
"github.event.discussion.title",
|
|
30
|
+
],
|
|
31
|
+
source: "discussion title/body",
|
|
32
|
+
},
|
|
33
|
+
{
|
|
34
|
+
fragments: ["github.event.discussion_comment.body"],
|
|
35
|
+
source: "discussion comment body",
|
|
36
|
+
},
|
|
37
|
+
{
|
|
38
|
+
fragments: ["github.event.client_payload."],
|
|
39
|
+
source: "repository_dispatch client payload",
|
|
40
|
+
},
|
|
41
|
+
];
|
|
42
|
+
/** Resolve the first matching untrusted expression source inside a run script. */
|
|
43
|
+
const getUnsafeRunSource = (runScript) => {
|
|
44
|
+
for (const source of untrustedRunExpressionSources) {
|
|
45
|
+
if (source.fragments.some((fragment) => runScript.includes(fragment))) {
|
|
46
|
+
return source.source;
|
|
47
|
+
}
|
|
48
|
+
}
|
|
49
|
+
return null;
|
|
50
|
+
};
|
|
51
|
+
/** Rule implementation for disallowing unsafe direct interpolation in `run`. */
|
|
52
|
+
const rule = {
|
|
53
|
+
create(context) {
|
|
54
|
+
return {
|
|
55
|
+
Program() {
|
|
56
|
+
const root = getWorkflowRoot(context);
|
|
57
|
+
if (root === null) {
|
|
58
|
+
return;
|
|
59
|
+
}
|
|
60
|
+
for (const job of getWorkflowJobs(root)) {
|
|
61
|
+
const stepsSequence = getMappingValueAsSequence(job.mapping, "steps");
|
|
62
|
+
if (stepsSequence === null) {
|
|
63
|
+
continue;
|
|
64
|
+
}
|
|
65
|
+
for (const entry of stepsSequence.entries) {
|
|
66
|
+
const stepMapping = unwrapYamlValue(entry);
|
|
67
|
+
if (stepMapping?.type !== "YAMLMapping") {
|
|
68
|
+
continue;
|
|
69
|
+
}
|
|
70
|
+
const runPair = getMappingPair(stepMapping, "run");
|
|
71
|
+
const runScript = getScalarStringValue(runPair?.value ?? null);
|
|
72
|
+
if (runPair === null || runScript === null) {
|
|
73
|
+
continue;
|
|
74
|
+
}
|
|
75
|
+
const unsafeSource = getUnsafeRunSource(runScript);
|
|
76
|
+
if (unsafeSource === null) {
|
|
77
|
+
continue;
|
|
78
|
+
}
|
|
79
|
+
context.report({
|
|
80
|
+
data: {
|
|
81
|
+
jobId: job.id,
|
|
82
|
+
source: unsafeSource,
|
|
83
|
+
},
|
|
84
|
+
messageId: "unsafeRunInterpolation",
|
|
85
|
+
node: (runPair.value ??
|
|
86
|
+
runPair),
|
|
87
|
+
});
|
|
88
|
+
}
|
|
89
|
+
}
|
|
90
|
+
},
|
|
91
|
+
};
|
|
92
|
+
},
|
|
93
|
+
meta: {
|
|
94
|
+
docs: {
|
|
95
|
+
configs: [
|
|
96
|
+
"github-actions.configs.all",
|
|
97
|
+
"github-actions.configs.security",
|
|
98
|
+
"github-actions.configs.strict",
|
|
99
|
+
],
|
|
100
|
+
description: "disallow directly embedding untrusted event payload values inside `run` scripts; move them through `env` first or pass them to an action input.",
|
|
101
|
+
recommended: false,
|
|
102
|
+
requiresTypeChecking: false,
|
|
103
|
+
ruleId: "R029",
|
|
104
|
+
ruleNumber: 29,
|
|
105
|
+
url: "https://nick2bad4u.github.io/eslint-plugin-github-actions-2/docs/rules/no-untrusted-input-in-run",
|
|
106
|
+
},
|
|
107
|
+
messages: {
|
|
108
|
+
unsafeRunInterpolation: "Job '{{jobId}}' interpolates untrusted {{source}} directly inside `run`. Assign the value to `env` first or pass it to an action input.",
|
|
109
|
+
},
|
|
110
|
+
schema: [],
|
|
111
|
+
type: "problem",
|
|
112
|
+
},
|
|
113
|
+
};
|
|
114
|
+
export default rule;
|
|
115
|
+
//# sourceMappingURL=no-untrusted-input-in-run.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"no-untrusted-input-in-run.js","sourceRoot":"","sources":["../../src/rules/no-untrusted-input-in-run.ts"],"names":[],"mappings":"AAMA,OAAO,EACH,cAAc,EACd,yBAAyB,EACzB,oBAAoB,EACpB,eAAe,EACf,eAAe,EACf,eAAe,GAClB,MAAM,+BAA+B,CAAC;AAEvC;;;GAGG;AACH,MAAM,6BAA6B,GAAG;IAClC;QACI,SAAS,EAAE;YACP,gCAAgC;YAChC,iCAAiC;SACpC;QACD,MAAM,EAAE,yBAAyB;KACpC;IACD;QACI,SAAS,EAAE,CAAC,yBAAyB,EAAE,0BAA0B,CAAC;QAClE,MAAM,EAAE,kBAAkB;KAC7B;IACD;QACI,SAAS,EAAE,CAAC,2BAA2B,CAAC;QACxC,MAAM,EAAE,cAAc;KACzB;IACD;QACI,SAAS,EAAE,CAAC,0BAA0B,CAAC;QACvC,MAAM,EAAE,aAAa;KACxB;IACD;QACI,SAAS,EAAE;YACP,8BAA8B;YAC9B,+BAA+B;SAClC;QACD,MAAM,EAAE,uBAAuB;KAClC;IACD;QACI,SAAS,EAAE,CAAC,sCAAsC,CAAC;QACnD,MAAM,EAAE,yBAAyB;KACpC;IACD;QACI,SAAS,EAAE,CAAC,8BAA8B,CAAC;QAC3C,MAAM,EAAE,oCAAoC;KAC/C;CACK,CAAC;AAEX,kFAAkF;AAClF,MAAM,kBAAkB,GAAG,CAAC,SAAiB,EAAiB,EAAE;IAC5D,KAAK,MAAM,MAAM,IAAI,6BAA6B,EAAE,CAAC;QACjD,IAAI,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,SAAS,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC;YACpE,OAAO,MAAM,CAAC,MAAM,CAAC;QACzB,CAAC;IACL,CAAC;IAED,OAAO,IAAI,CAAC;AAChB,CAAC,CAAC;AAEF,gFAAgF;AAChF,MAAM,IAAI,GAAoB;IAC1B,MAAM,CAAC,OAAO;QACV,OAAO;YACH,OAAO;gBACH,MAAM,IAAI,GAAG,eAAe,CAAC,OAAO,CAAC,CAAC;gBAEtC,IAAI,IAAI,KAAK,IAAI,EAAE,CAAC;oBAChB,OAAO;gBACX,CAAC;gBAED,KAAK,MAAM,GAAG,IAAI,eAAe,CAAC,IAAI,CAAC,EAAE,CAAC;oBACtC,MAAM,aAAa,GAAG,yBAAyB,CAC3C,GAAG,CAAC,OAAO,EACX,OAAO,CACV,CAAC;oBAEF,IAAI,aAAa,KAAK,IAAI,EAAE,CAAC;wBACzB,SAAS;oBACb,CAAC;oBAED,KAAK,MAAM,KAAK,IAAI,aAAa,CAAC,OAAO,EAAE,CAAC;wBACxC,MAAM,WAAW,GAAG,eAAe,CAAC,KAAK,CAAC,CAAC;wBAE3C,IAAI,WAAW,EAAE,IAAI,KAAK,aAAa,EAAE,CAAC;4BACtC,SAAS;wBACb,CAAC;wBAED,MAAM,OAAO,GAAG,cAAc,CAAC,WAAW,EAAE,KAAK,CAAC,CAAC;wBACnD,MAAM,SAAS,GAAG,oBAAoB,CAClC,OAAO,EAAE,KAAK,IAAI,IAAI,CACzB,CAAC;wBAEF,IAAI,OAAO,KAAK,IAAI,IAAI,SAAS,KAAK,IAAI,EAAE,CAAC;4BACzC,SAAS;wBACb,CAAC;wBAED,MAAM,YAAY,GAAG,kBAAkB,CAAC,SAAS,CAAC,CAAC;wBAEnD,IAAI,YAAY,KAAK,IAAI,EAAE,CAAC;4BACxB,SAAS;wBACb,CAAC;wBAED,OAAO,CAAC,MAAM,CAAC;4BACX,IAAI,EAAE;gCACF,KAAK,EAAE,GAAG,CAAC,EAAE;gCACb,MAAM,EAAE,YAAY;6BACvB;4BACD,SAAS,EAAE,wBAAwB;4BACnC,IAAI,EAAE,CAAC,OAAO,CAAC,KAAK;gCAChB,OAAO,CAAyB;yBACvC,CAAC,CAAC;oBACP,CAAC;gBACL,CAAC;YACL,CAAC;SACJ,CAAC;IACN,CAAC;IACD,IAAI,EAAE;QACF,IAAI,EAAE;YACF,OAAO,EAAE;gBACL,4BAA4B;gBAC5B,iCAAiC;gBACjC,+BAA+B;aAClC;YACD,WAAW,EACP,iJAAiJ;YACrJ,WAAW,EAAE,KAAK;YAClB,oBAAoB,EAAE,KAAK;YAC3B,MAAM,EAAE,MAAM;YACd,UAAU,EAAE,EAAE;YACd,GAAG,EAAE,kGAAkG;SAC1G;QACD,QAAQ,EAAE;YACN,sBAAsB,EAClB,yIAAyI;SAChJ;QACD,MAAM,EAAE,EAAE;QACV,IAAI,EAAE,SAAS;KACG;CACzB,CAAC;AAEF,eAAe,IAAI,CAAC"}
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @packageDocumentation
|
|
3
|
+
* Disallow declared inputs that are never used in a composite action.
|
|
4
|
+
*/
|
|
5
|
+
import type { Rule } from "eslint";
|
|
6
|
+
/** Rule implementation for unused composite input checks. */
|
|
7
|
+
declare const rule: Rule.RuleModule;
|
|
8
|
+
export default rule;
|
|
9
|
+
//# sourceMappingURL=no-unused-input-in-composite.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"no-unused-input-in-composite.d.ts","sourceRoot":"","sources":["../../src/rules/no-unused-input-in-composite.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAcnC,6DAA6D;AAC7D,QAAA,MAAM,IAAI,EAAE,IAAI,CAAC,UAyFhB,CAAC;AAEF,eAAe,IAAI,CAAC"}
|
|
@@ -0,0 +1,78 @@
|
|
|
1
|
+
import { isActionMetadataFile } from "../_internal/lint-targets.js";
|
|
2
|
+
import { getMappingPair, getMappingValueAsMapping, getScalarStringValue, getWorkflowRoot, } from "../_internal/workflow-yaml.js";
|
|
3
|
+
import { collectYamlStringScalars } from "../_internal/yaml-traversal.js";
|
|
4
|
+
/** Matches `inputs.<id>` references in composite-step string values. */
|
|
5
|
+
const INPUT_REFERENCE_PATTERN = /inputs\.(?<inputId>[\w-]+)/gu;
|
|
6
|
+
/** Rule implementation for unused composite input checks. */
|
|
7
|
+
const rule = {
|
|
8
|
+
create(context) {
|
|
9
|
+
return {
|
|
10
|
+
Program() {
|
|
11
|
+
if (!isActionMetadataFile(context.filename)) {
|
|
12
|
+
return;
|
|
13
|
+
}
|
|
14
|
+
const root = getWorkflowRoot(context);
|
|
15
|
+
if (root === null) {
|
|
16
|
+
return;
|
|
17
|
+
}
|
|
18
|
+
const runsMapping = getMappingValueAsMapping(root, "runs");
|
|
19
|
+
const inputsMapping = getMappingValueAsMapping(root, "inputs");
|
|
20
|
+
if (runsMapping === null || inputsMapping === null) {
|
|
21
|
+
return;
|
|
22
|
+
}
|
|
23
|
+
const usingRuntime = getScalarStringValue(getMappingPair(runsMapping, "using")?.value);
|
|
24
|
+
if (usingRuntime !== "composite") {
|
|
25
|
+
return;
|
|
26
|
+
}
|
|
27
|
+
const allScalarValues = collectYamlStringScalars(runsMapping);
|
|
28
|
+
const referencedInputIds = new Set();
|
|
29
|
+
for (const scalarValue of allScalarValues) {
|
|
30
|
+
for (const match of scalarValue.matchAll(INPUT_REFERENCE_PATTERN)) {
|
|
31
|
+
const matchedInputId = match.groups?.["inputId"];
|
|
32
|
+
if (matchedInputId === undefined) {
|
|
33
|
+
continue;
|
|
34
|
+
}
|
|
35
|
+
referencedInputIds.add(matchedInputId);
|
|
36
|
+
}
|
|
37
|
+
}
|
|
38
|
+
for (const inputPair of inputsMapping.pairs) {
|
|
39
|
+
const inputId = getScalarStringValue(inputPair.key);
|
|
40
|
+
if (inputId === null) {
|
|
41
|
+
continue;
|
|
42
|
+
}
|
|
43
|
+
if (referencedInputIds.has(inputId)) {
|
|
44
|
+
continue;
|
|
45
|
+
}
|
|
46
|
+
context.report({
|
|
47
|
+
data: {
|
|
48
|
+
inputId,
|
|
49
|
+
},
|
|
50
|
+
messageId: "unusedCompositeInput",
|
|
51
|
+
node: inputPair.key,
|
|
52
|
+
});
|
|
53
|
+
}
|
|
54
|
+
},
|
|
55
|
+
};
|
|
56
|
+
},
|
|
57
|
+
meta: {
|
|
58
|
+
docs: {
|
|
59
|
+
configs: [
|
|
60
|
+
"github-actions.configs.actionMetadata",
|
|
61
|
+
"github-actions.configs.all",
|
|
62
|
+
],
|
|
63
|
+
description: "disallow declared composite-action inputs that are never referenced.",
|
|
64
|
+
recommended: false,
|
|
65
|
+
requiresTypeChecking: false,
|
|
66
|
+
ruleId: "R053",
|
|
67
|
+
ruleNumber: 53,
|
|
68
|
+
url: "https://nick2bad4u.github.io/eslint-plugin-github-actions-2/docs/rules/no-unused-input-in-composite",
|
|
69
|
+
},
|
|
70
|
+
messages: {
|
|
71
|
+
unusedCompositeInput: "Composite action input '{{inputId}}' is declared but never referenced via `inputs.{{inputId}}`.",
|
|
72
|
+
},
|
|
73
|
+
schema: [],
|
|
74
|
+
type: "suggestion",
|
|
75
|
+
},
|
|
76
|
+
};
|
|
77
|
+
export default rule;
|
|
78
|
+
//# sourceMappingURL=no-unused-input-in-composite.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"no-unused-input-in-composite.js","sourceRoot":"","sources":["../../src/rules/no-unused-input-in-composite.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,oBAAoB,EAAE,MAAM,8BAA8B,CAAC;AACpE,OAAO,EACH,cAAc,EACd,wBAAwB,EACxB,oBAAoB,EACpB,eAAe,GAClB,MAAM,+BAA+B,CAAC;AACvC,OAAO,EAAE,wBAAwB,EAAE,MAAM,gCAAgC,CAAC;AAE1E,wEAAwE;AACxE,MAAM,uBAAuB,GAAG,8BAA8B,CAAC;AAE/D,6DAA6D;AAC7D,MAAM,IAAI,GAAoB;IAC1B,MAAM,CAAC,OAAO;QACV,OAAO;YACH,OAAO;gBACH,IAAI,CAAC,oBAAoB,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC;oBAC1C,OAAO;gBACX,CAAC;gBAED,MAAM,IAAI,GAAG,eAAe,CAAC,OAAO,CAAC,CAAC;gBAEtC,IAAI,IAAI,KAAK,IAAI,EAAE,CAAC;oBAChB,OAAO;gBACX,CAAC;gBAED,MAAM,WAAW,GAAG,wBAAwB,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;gBAC3D,MAAM,aAAa,GAAG,wBAAwB,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;gBAE/D,IAAI,WAAW,KAAK,IAAI,IAAI,aAAa,KAAK,IAAI,EAAE,CAAC;oBACjD,OAAO;gBACX,CAAC;gBAED,MAAM,YAAY,GAAG,oBAAoB,CACrC,cAAc,CAAC,WAAW,EAAE,OAAO,CAAC,EAAE,KAAK,CAC9C,CAAC;gBAEF,IAAI,YAAY,KAAK,WAAW,EAAE,CAAC;oBAC/B,OAAO;gBACX,CAAC;gBAED,MAAM,eAAe,GAAG,wBAAwB,CAAC,WAAW,CAAC,CAAC;gBAC9D,MAAM,kBAAkB,GAAG,IAAI,GAAG,EAAU,CAAC;gBAE7C,KAAK,MAAM,WAAW,IAAI,eAAe,EAAE,CAAC;oBACxC,KAAK,MAAM,KAAK,IAAI,WAAW,CAAC,QAAQ,CACpC,uBAAuB,CAC1B,EAAE,CAAC;wBACA,MAAM,cAAc,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,SAAS,CAAC,CAAC;wBAEjD,IAAI,cAAc,KAAK,SAAS,EAAE,CAAC;4BAC/B,SAAS;wBACb,CAAC;wBAED,kBAAkB,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC;oBAC3C,CAAC;gBACL,CAAC;gBAED,KAAK,MAAM,SAAS,IAAI,aAAa,CAAC,KAAK,EAAE,CAAC;oBAC1C,MAAM,OAAO,GAAG,oBAAoB,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;oBAEpD,IAAI,OAAO,KAAK,IAAI,EAAE,CAAC;wBACnB,SAAS;oBACb,CAAC;oBAED,IAAI,kBAAkB,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC;wBAClC,SAAS;oBACb,CAAC;oBAED,OAAO,CAAC,MAAM,CAAC;wBACX,IAAI,EAAE;4BACF,OAAO;yBACV;wBACD,SAAS,EAAE,sBAAsB;wBACjC,IAAI,EAAE,SAAS,CAAC,GAA2B;qBAC9C,CAAC,CAAC;gBACP,CAAC;YACL,CAAC;SACJ,CAAC;IACN,CAAC;IACD,IAAI,EAAE;QACF,IAAI,EAAE;YACF,OAAO,EAAE;gBACL,uCAAuC;gBACvC,4BAA4B;aAC/B;YACD,WAAW,EACP,sEAAsE;YAC1E,WAAW,EAAE,KAAK;YAClB,oBAAoB,EAAE,KAAK;YAC3B,MAAM,EAAE,MAAM;YACd,UAAU,EAAE,EAAE;YACd,GAAG,EAAE,qGAAqG;SAC7G;QACD,QAAQ,EAAE;YACN,oBAAoB,EAChB,iGAAiG;SACxG;QACD,MAAM,EAAE,EAAE;QACV,IAAI,EAAE,YAAY;KACA;CACzB,CAAC;AAEF,eAAe,IAAI,CAAC"}
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @packageDocumentation
|
|
3
|
+
* Disallow broad `write-all` GitHub token permissions.
|
|
4
|
+
*/
|
|
5
|
+
import type { Rule } from "eslint";
|
|
6
|
+
/** Rule implementation for disallowing `permissions: write-all`. */
|
|
7
|
+
declare const rule: Rule.RuleModule;
|
|
8
|
+
export default rule;
|
|
9
|
+
//# sourceMappingURL=no-write-all-permissions.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"no-write-all-permissions.d.ts","sourceRoot":"","sources":["../../src/rules/no-write-all-permissions.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAiBnC,oEAAoE;AACpE,QAAA,MAAM,IAAI,EAAE,IAAI,CAAC,UAgFhB,CAAC;AAEF,eAAe,IAAI,CAAC"}
|