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,70 @@
|
|
|
1
|
+
import { getMappingPair, getMappingValueAsMapping, getScalarStringValue, getWorkflowRoot, unwrapYamlValue, } from "../_internal/workflow-yaml.js";
|
|
2
|
+
/** Rule implementation for requiring explicit job names. */
|
|
3
|
+
const rule = {
|
|
4
|
+
create(context) {
|
|
5
|
+
return {
|
|
6
|
+
Program() {
|
|
7
|
+
const root = getWorkflowRoot(context);
|
|
8
|
+
if (root === null) {
|
|
9
|
+
return;
|
|
10
|
+
}
|
|
11
|
+
const jobsMapping = getMappingValueAsMapping(root, "jobs");
|
|
12
|
+
if (jobsMapping === null) {
|
|
13
|
+
return;
|
|
14
|
+
}
|
|
15
|
+
for (const pair of jobsMapping.pairs) {
|
|
16
|
+
const jobId = getScalarStringValue(pair.key) ?? "<unknown>";
|
|
17
|
+
const jobValue = unwrapYamlValue(pair.value);
|
|
18
|
+
if (jobValue?.type !== "YAMLMapping") {
|
|
19
|
+
context.report({
|
|
20
|
+
data: { jobId },
|
|
21
|
+
messageId: "missingJobName",
|
|
22
|
+
node: (pair.value ?? pair),
|
|
23
|
+
});
|
|
24
|
+
continue;
|
|
25
|
+
}
|
|
26
|
+
const namePair = getMappingPair(jobValue, "name");
|
|
27
|
+
if (namePair === null) {
|
|
28
|
+
context.report({
|
|
29
|
+
data: { jobId },
|
|
30
|
+
messageId: "missingJobName",
|
|
31
|
+
node: pair.key,
|
|
32
|
+
});
|
|
33
|
+
continue;
|
|
34
|
+
}
|
|
35
|
+
const nameValue = getScalarStringValue(namePair.value);
|
|
36
|
+
if (nameValue === null || nameValue.trim().length === 0) {
|
|
37
|
+
context.report({
|
|
38
|
+
data: { jobId },
|
|
39
|
+
messageId: "invalidJobName",
|
|
40
|
+
node: (namePair.value ??
|
|
41
|
+
namePair),
|
|
42
|
+
});
|
|
43
|
+
}
|
|
44
|
+
}
|
|
45
|
+
},
|
|
46
|
+
};
|
|
47
|
+
},
|
|
48
|
+
meta: {
|
|
49
|
+
docs: {
|
|
50
|
+
configs: [
|
|
51
|
+
"github-actions.configs.all",
|
|
52
|
+
"github-actions.configs.strict",
|
|
53
|
+
],
|
|
54
|
+
description: "require every workflow job to declare a non-empty string `name` for readable run summaries.",
|
|
55
|
+
recommended: false,
|
|
56
|
+
requiresTypeChecking: false,
|
|
57
|
+
ruleId: "R007",
|
|
58
|
+
ruleNumber: 7,
|
|
59
|
+
url: "https://nick2bad4u.github.io/eslint-plugin-github-actions-2/docs/rules/require-job-name",
|
|
60
|
+
},
|
|
61
|
+
messages: {
|
|
62
|
+
invalidJobName: "Job '{{jobId}}' must set `name` to a non-empty string.",
|
|
63
|
+
missingJobName: "Job '{{jobId}}' is missing a human-readable `name`.",
|
|
64
|
+
},
|
|
65
|
+
schema: [],
|
|
66
|
+
type: "suggestion",
|
|
67
|
+
},
|
|
68
|
+
};
|
|
69
|
+
export default rule;
|
|
70
|
+
//# sourceMappingURL=require-job-name.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"require-job-name.js","sourceRoot":"","sources":["../../src/rules/require-job-name.ts"],"names":[],"mappings":"AAOA,OAAO,EACH,cAAc,EACd,wBAAwB,EACxB,oBAAoB,EACpB,eAAe,EACf,eAAe,GAClB,MAAM,+BAA+B,CAAC;AAEvC,4DAA4D;AAC5D,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,WAAW,GAAG,wBAAwB,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;gBAE3D,IAAI,WAAW,KAAK,IAAI,EAAE,CAAC;oBACvB,OAAO;gBACX,CAAC;gBAED,KAAK,MAAM,IAAI,IAAI,WAAW,CAAC,KAAK,EAAE,CAAC;oBACnC,MAAM,KAAK,GAAG,oBAAoB,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,WAAW,CAAC;oBAC5D,MAAM,QAAQ,GAAG,eAAe,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;oBAE7C,IAAI,QAAQ,EAAE,IAAI,KAAK,aAAa,EAAE,CAAC;wBACnC,OAAO,CAAC,MAAM,CAAC;4BACX,IAAI,EAAE,EAAE,KAAK,EAAE;4BACf,SAAS,EAAE,gBAAgB;4BAC3B,IAAI,EAAE,CAAC,IAAI,CAAC,KAAK,IAAI,IAAI,CAAyB;yBACrD,CAAC,CAAC;wBAEH,SAAS;oBACb,CAAC;oBAED,MAAM,QAAQ,GAAG,cAAc,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;oBAElD,IAAI,QAAQ,KAAK,IAAI,EAAE,CAAC;wBACpB,OAAO,CAAC,MAAM,CAAC;4BACX,IAAI,EAAE,EAAE,KAAK,EAAE;4BACf,SAAS,EAAE,gBAAgB;4BAC3B,IAAI,EAAE,IAAI,CAAC,GAA2C;yBACzD,CAAC,CAAC;wBAEH,SAAS;oBACb,CAAC;oBAED,MAAM,SAAS,GAAG,oBAAoB,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;oBAEvD,IAAI,SAAS,KAAK,IAAI,IAAI,SAAS,CAAC,IAAI,EAAE,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;wBACtD,OAAO,CAAC,MAAM,CAAC;4BACX,IAAI,EAAE,EAAE,KAAK,EAAE;4BACf,SAAS,EAAE,gBAAgB;4BAC3B,IAAI,EAAE,CAAC,QAAQ,CAAC,KAAK;gCACjB,QAAQ,CAAyB;yBACxC,CAAC,CAAC;oBACP,CAAC;gBACL,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,6FAA6F;YACjG,WAAW,EAAE,KAAK;YAClB,oBAAoB,EAAE,KAAK;YAC3B,MAAM,EAAE,MAAM;YACd,UAAU,EAAE,CAAC;YACb,GAAG,EAAE,yFAAyF;SACjG;QACD,QAAQ,EAAE;YACN,cAAc,EACV,wDAAwD;YAC5D,cAAc,EACV,qDAAqD;SAC5D;QACD,MAAM,EAAE,EAAE;QACV,IAAI,EAAE,YAAY;KACA;CACzB,CAAC;AAEF,eAAe,IAAI,CAAC"}
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @packageDocumentation
|
|
3
|
+
* Require every workflow step to declare a string name.
|
|
4
|
+
*/
|
|
5
|
+
import type { Rule } from "eslint";
|
|
6
|
+
/** Rule implementation for requiring explicit job step names. */
|
|
7
|
+
declare const rule: Rule.RuleModule;
|
|
8
|
+
export default rule;
|
|
9
|
+
//# sourceMappingURL=require-job-step-name.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"require-job-step-name.d.ts","sourceRoot":"","sources":["../../src/rules/require-job-step-name.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAWnC,iEAAiE;AACjE,QAAA,MAAM,IAAI,EAAE,IAAI,CAAC,UAoFhB,CAAC;AAEF,eAAe,IAAI,CAAC"}
|
|
@@ -0,0 +1,71 @@
|
|
|
1
|
+
import { getMappingPair, getMappingValueAsSequence, getScalarStringValue, getWorkflowJobs, getWorkflowRoot, unwrapYamlValue, } from "../_internal/workflow-yaml.js";
|
|
2
|
+
/** Rule implementation for requiring explicit job step names. */
|
|
3
|
+
const rule = {
|
|
4
|
+
create(context) {
|
|
5
|
+
return {
|
|
6
|
+
Program() {
|
|
7
|
+
const root = getWorkflowRoot(context);
|
|
8
|
+
if (root === null) {
|
|
9
|
+
return;
|
|
10
|
+
}
|
|
11
|
+
for (const job of getWorkflowJobs(root)) {
|
|
12
|
+
const stepsSequence = getMappingValueAsSequence(job.mapping, "steps");
|
|
13
|
+
if (stepsSequence === null) {
|
|
14
|
+
continue;
|
|
15
|
+
}
|
|
16
|
+
for (const entry of stepsSequence.entries) {
|
|
17
|
+
const stepMapping = unwrapYamlValue(entry);
|
|
18
|
+
if (stepMapping?.type !== "YAMLMapping") {
|
|
19
|
+
continue;
|
|
20
|
+
}
|
|
21
|
+
const namePair = getMappingPair(stepMapping, "name");
|
|
22
|
+
if (namePair === null) {
|
|
23
|
+
context.report({
|
|
24
|
+
data: {
|
|
25
|
+
jobId: job.id,
|
|
26
|
+
},
|
|
27
|
+
messageId: "missingStepName",
|
|
28
|
+
node: stepMapping,
|
|
29
|
+
});
|
|
30
|
+
continue;
|
|
31
|
+
}
|
|
32
|
+
const nameValue = getScalarStringValue(namePair.value);
|
|
33
|
+
if (nameValue === null ||
|
|
34
|
+
nameValue.trim().length === 0) {
|
|
35
|
+
context.report({
|
|
36
|
+
data: {
|
|
37
|
+
jobId: job.id,
|
|
38
|
+
},
|
|
39
|
+
messageId: "invalidStepName",
|
|
40
|
+
node: (namePair.value ??
|
|
41
|
+
namePair),
|
|
42
|
+
});
|
|
43
|
+
}
|
|
44
|
+
}
|
|
45
|
+
}
|
|
46
|
+
},
|
|
47
|
+
};
|
|
48
|
+
},
|
|
49
|
+
meta: {
|
|
50
|
+
docs: {
|
|
51
|
+
configs: [
|
|
52
|
+
"github-actions.configs.all",
|
|
53
|
+
"github-actions.configs.strict",
|
|
54
|
+
],
|
|
55
|
+
description: "require every workflow step to declare a non-empty string `name` so job logs remain readable.",
|
|
56
|
+
recommended: false,
|
|
57
|
+
requiresTypeChecking: false,
|
|
58
|
+
ruleId: "R008",
|
|
59
|
+
ruleNumber: 8,
|
|
60
|
+
url: "https://nick2bad4u.github.io/eslint-plugin-github-actions-2/docs/rules/require-job-step-name",
|
|
61
|
+
},
|
|
62
|
+
messages: {
|
|
63
|
+
invalidStepName: "A step in job '{{jobId}}' must set `name` to a non-empty string.",
|
|
64
|
+
missingStepName: "A step in job '{{jobId}}' is missing a human-readable `name`.",
|
|
65
|
+
},
|
|
66
|
+
schema: [],
|
|
67
|
+
type: "suggestion",
|
|
68
|
+
},
|
|
69
|
+
};
|
|
70
|
+
export default rule;
|
|
71
|
+
//# sourceMappingURL=require-job-step-name.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"require-job-step-name.js","sourceRoot":"","sources":["../../src/rules/require-job-step-name.ts"],"names":[],"mappings":"AAMA,OAAO,EACH,cAAc,EACd,yBAAyB,EACzB,oBAAoB,EACpB,eAAe,EACf,eAAe,EACf,eAAe,GAClB,MAAM,+BAA+B,CAAC;AAEvC,iEAAiE;AACjE,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,QAAQ,GAAG,cAAc,CAAC,WAAW,EAAE,MAAM,CAAC,CAAC;wBAErD,IAAI,QAAQ,KAAK,IAAI,EAAE,CAAC;4BACpB,OAAO,CAAC,MAAM,CAAC;gCACX,IAAI,EAAE;oCACF,KAAK,EAAE,GAAG,CAAC,EAAE;iCAChB;gCACD,SAAS,EAAE,iBAAiB;gCAC5B,IAAI,EAAE,WAAmC;6BAC5C,CAAC,CAAC;4BAEH,SAAS;wBACb,CAAC;wBAED,MAAM,SAAS,GAAG,oBAAoB,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;wBAEvD,IACI,SAAS,KAAK,IAAI;4BAClB,SAAS,CAAC,IAAI,EAAE,CAAC,MAAM,KAAK,CAAC,EAC/B,CAAC;4BACC,OAAO,CAAC,MAAM,CAAC;gCACX,IAAI,EAAE;oCACF,KAAK,EAAE,GAAG,CAAC,EAAE;iCAChB;gCACD,SAAS,EAAE,iBAAiB;gCAC5B,IAAI,EAAE,CAAC,QAAQ,CAAC,KAAK;oCACjB,QAAQ,CAAyB;6BACxC,CAAC,CAAC;wBACP,CAAC;oBACL,CAAC;gBACL,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,+FAA+F;YACnG,WAAW,EAAE,KAAK;YAClB,oBAAoB,EAAE,KAAK;YAC3B,MAAM,EAAE,MAAM;YACd,UAAU,EAAE,CAAC;YACb,GAAG,EAAE,8FAA8F;SACtG;QACD,QAAQ,EAAE;YACN,eAAe,EACX,kEAAkE;YACtE,eAAe,EACX,+DAA+D;SACtE;QACD,MAAM,EAAE,EAAE;QACV,IAAI,EAAE,YAAY;KACA;CACzB,CAAC;AAEF,eAAe,IAAI,CAAC"}
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @packageDocumentation
|
|
3
|
+
* Require bounded job timeouts for GitHub Actions jobs.
|
|
4
|
+
*/
|
|
5
|
+
import type { Rule } from "eslint";
|
|
6
|
+
/** Rule implementation for requiring bounded timeout-minutes on workflow jobs. */
|
|
7
|
+
declare const rule: Rule.RuleModule;
|
|
8
|
+
export default rule;
|
|
9
|
+
//# sourceMappingURL=require-job-timeout-minutes.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"require-job-timeout-minutes.d.ts","sourceRoot":"","sources":["../../src/rules/require-job-timeout-minutes.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAoBnC,kFAAkF;AAClF,QAAA,MAAM,IAAI,EAAE,IAAI,CAAC,UAoHhB,CAAC;AAEF,eAAe,IAAI,CAAC"}
|
|
@@ -0,0 +1,99 @@
|
|
|
1
|
+
import { getMappingPair, getScalarNumberValue, getWorkflowJobs, getWorkflowRoot, isGithubExpressionScalar, } from "../_internal/workflow-yaml.js";
|
|
2
|
+
/** Default upper bound used when validating workflow job timeouts. */
|
|
3
|
+
const DEFAULT_MAX_MINUTES = 60;
|
|
4
|
+
/** Rule implementation for requiring bounded timeout-minutes on workflow jobs. */
|
|
5
|
+
const rule = {
|
|
6
|
+
create(context) {
|
|
7
|
+
const [options] = context.options;
|
|
8
|
+
const maxMinutes = options?.maxMinutes ?? DEFAULT_MAX_MINUTES;
|
|
9
|
+
return {
|
|
10
|
+
Program() {
|
|
11
|
+
const root = getWorkflowRoot(context);
|
|
12
|
+
if (root === null) {
|
|
13
|
+
return;
|
|
14
|
+
}
|
|
15
|
+
for (const job of getWorkflowJobs(root)) {
|
|
16
|
+
if (getMappingPair(job.mapping, "uses") !== null) {
|
|
17
|
+
continue;
|
|
18
|
+
}
|
|
19
|
+
const timeoutPair = getMappingPair(job.mapping, "timeout-minutes");
|
|
20
|
+
if (timeoutPair === null) {
|
|
21
|
+
context.report({
|
|
22
|
+
data: {
|
|
23
|
+
jobId: job.id,
|
|
24
|
+
},
|
|
25
|
+
messageId: "missingTimeout",
|
|
26
|
+
node: job.idNode,
|
|
27
|
+
});
|
|
28
|
+
continue;
|
|
29
|
+
}
|
|
30
|
+
if (isGithubExpressionScalar(timeoutPair.value)) {
|
|
31
|
+
continue;
|
|
32
|
+
}
|
|
33
|
+
const timeoutMinutes = getScalarNumberValue(timeoutPair.value);
|
|
34
|
+
if (timeoutMinutes === null ||
|
|
35
|
+
!Number.isInteger(timeoutMinutes) ||
|
|
36
|
+
timeoutMinutes <= 0) {
|
|
37
|
+
context.report({
|
|
38
|
+
data: {
|
|
39
|
+
jobId: job.id,
|
|
40
|
+
},
|
|
41
|
+
messageId: "invalidTimeout",
|
|
42
|
+
node: timeoutPair.value ?? timeoutPair,
|
|
43
|
+
});
|
|
44
|
+
continue;
|
|
45
|
+
}
|
|
46
|
+
if (timeoutMinutes > maxMinutes) {
|
|
47
|
+
context.report({
|
|
48
|
+
data: {
|
|
49
|
+
actualMinutes: String(timeoutMinutes),
|
|
50
|
+
jobId: job.id,
|
|
51
|
+
maxMinutes: String(maxMinutes),
|
|
52
|
+
},
|
|
53
|
+
messageId: "timeoutTooLarge",
|
|
54
|
+
node: timeoutPair.value ?? timeoutPair,
|
|
55
|
+
});
|
|
56
|
+
}
|
|
57
|
+
}
|
|
58
|
+
},
|
|
59
|
+
};
|
|
60
|
+
},
|
|
61
|
+
meta: {
|
|
62
|
+
defaultOptions: [{}],
|
|
63
|
+
docs: {
|
|
64
|
+
configs: [
|
|
65
|
+
"github-actions.configs.all",
|
|
66
|
+
"github-actions.configs.recommended",
|
|
67
|
+
"github-actions.configs.strict",
|
|
68
|
+
],
|
|
69
|
+
description: "require every non-reusable workflow job to define a bounded `timeout-minutes` value.",
|
|
70
|
+
recommended: true,
|
|
71
|
+
requiresTypeChecking: false,
|
|
72
|
+
ruleId: "R002",
|
|
73
|
+
ruleNumber: 2,
|
|
74
|
+
url: "https://nick2bad4u.github.io/eslint-plugin-github-actions-2/docs/rules/require-job-timeout-minutes",
|
|
75
|
+
},
|
|
76
|
+
messages: {
|
|
77
|
+
invalidTimeout: "Job '{{jobId}}' has an invalid `timeout-minutes` value. Use a positive integer or a GitHub expression.",
|
|
78
|
+
missingTimeout: "Job '{{jobId}}' is missing `timeout-minutes`. Add an explicit timeout to prevent hung runners from waiting indefinitely.",
|
|
79
|
+
timeoutTooLarge: "Job '{{jobId}}' sets `timeout-minutes` to {{actualMinutes}}, which exceeds the configured maximum of {{maxMinutes}}.",
|
|
80
|
+
},
|
|
81
|
+
schema: [
|
|
82
|
+
{
|
|
83
|
+
additionalProperties: false,
|
|
84
|
+
description: "Optional configuration for the maximum allowed job timeout in minutes.",
|
|
85
|
+
properties: {
|
|
86
|
+
maxMinutes: {
|
|
87
|
+
description: "Maximum allowed timeout-minutes value for a non-reusable workflow job.",
|
|
88
|
+
minimum: 1,
|
|
89
|
+
type: "integer",
|
|
90
|
+
},
|
|
91
|
+
},
|
|
92
|
+
type: "object",
|
|
93
|
+
},
|
|
94
|
+
],
|
|
95
|
+
type: "suggestion",
|
|
96
|
+
},
|
|
97
|
+
};
|
|
98
|
+
export default rule;
|
|
99
|
+
//# sourceMappingURL=require-job-timeout-minutes.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"require-job-timeout-minutes.js","sourceRoot":"","sources":["../../src/rules/require-job-timeout-minutes.ts"],"names":[],"mappings":"AAMA,OAAO,EACH,cAAc,EACd,oBAAoB,EACpB,eAAe,EACf,eAAe,EACf,wBAAwB,GAC3B,MAAM,+BAA+B,CAAC;AASvC,sEAAsE;AACtE,MAAM,mBAAmB,GAAG,EAAE,CAAC;AAE/B,kFAAkF;AAClF,MAAM,IAAI,GAAoB;IAC1B,MAAM,CAAC,OAAO;QACV,MAAM,CAAC,OAAO,CAAC,GAAG,OAAO,CAAC,OAA0C,CAAC;QACrE,MAAM,UAAU,GAAG,OAAO,EAAE,UAAU,IAAI,mBAAmB,CAAC;QAE9D,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,IAAI,cAAc,CAAC,GAAG,CAAC,OAAO,EAAE,MAAM,CAAC,KAAK,IAAI,EAAE,CAAC;wBAC/C,SAAS;oBACb,CAAC;oBAED,MAAM,WAAW,GAAG,cAAc,CAC9B,GAAG,CAAC,OAAO,EACX,iBAAiB,CACpB,CAAC;oBAEF,IAAI,WAAW,KAAK,IAAI,EAAE,CAAC;wBACvB,OAAO,CAAC,MAAM,CAAC;4BACX,IAAI,EAAE;gCACF,KAAK,EAAE,GAAG,CAAC,EAAE;6BAChB;4BACD,SAAS,EAAE,gBAAgB;4BAC3B,IAAI,EAAE,GAAG,CAAC,MAAM;yBACnB,CAAC,CAAC;wBAEH,SAAS;oBACb,CAAC;oBAED,IAAI,wBAAwB,CAAC,WAAW,CAAC,KAAK,CAAC,EAAE,CAAC;wBAC9C,SAAS;oBACb,CAAC;oBAED,MAAM,cAAc,GAAG,oBAAoB,CACvC,WAAW,CAAC,KAAK,CACpB,CAAC;oBAEF,IACI,cAAc,KAAK,IAAI;wBACvB,CAAC,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC;wBACjC,cAAc,IAAI,CAAC,EACrB,CAAC;wBACC,OAAO,CAAC,MAAM,CAAC;4BACX,IAAI,EAAE;gCACF,KAAK,EAAE,GAAG,CAAC,EAAE;6BAChB;4BACD,SAAS,EAAE,gBAAgB;4BAC3B,IAAI,EAAE,WAAW,CAAC,KAAK,IAAI,WAAW;yBACzC,CAAC,CAAC;wBAEH,SAAS;oBACb,CAAC;oBAED,IAAI,cAAc,GAAG,UAAU,EAAE,CAAC;wBAC9B,OAAO,CAAC,MAAM,CAAC;4BACX,IAAI,EAAE;gCACF,aAAa,EAAE,MAAM,CAAC,cAAc,CAAC;gCACrC,KAAK,EAAE,GAAG,CAAC,EAAE;gCACb,UAAU,EAAE,MAAM,CAAC,UAAU,CAAC;6BACjC;4BACD,SAAS,EAAE,iBAAiB;4BAC5B,IAAI,EAAE,WAAW,CAAC,KAAK,IAAI,WAAW;yBACzC,CAAC,CAAC;oBACP,CAAC;gBACL,CAAC;YACL,CAAC;SACJ,CAAC;IACN,CAAC;IACD,IAAI,EAAE;QACF,cAAc,EAAE,CAAC,EAAE,CAAC;QACpB,IAAI,EAAE;YACF,OAAO,EAAE;gBACL,4BAA4B;gBAC5B,oCAAoC;gBACpC,+BAA+B;aAClC;YACD,WAAW,EACP,sFAAsF;YAC1F,WAAW,EAAE,IAAI;YACjB,oBAAoB,EAAE,KAAK;YAC3B,MAAM,EAAE,MAAM;YACd,UAAU,EAAE,CAAC;YACb,GAAG,EAAE,oGAAoG;SAC5G;QACD,QAAQ,EAAE;YACN,cAAc,EACV,wGAAwG;YAC5G,cAAc,EACV,0HAA0H;YAC9H,eAAe,EACX,sHAAsH;SAC7H;QACD,MAAM,EAAE;YACJ;gBACI,oBAAoB,EAAE,KAAK;gBAC3B,WAAW,EACP,wEAAwE;gBAC5E,UAAU,EAAE;oBACR,UAAU,EAAE;wBACR,WAAW,EACP,wEAAwE;wBAC5E,OAAO,EAAE,CAAC;wBACV,IAAI,EAAE,SAAS;qBAClB;iBACJ;gBACD,IAAI,EAAE,QAAQ;aACjB;SACJ;QACD,IAAI,EAAE,YAAY;KACA;CACzB,CAAC;AAEF,eAAe,IAAI,CAAC"}
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @packageDocumentation
|
|
3
|
+
* Require merge-queue-aware workflows to listen for merge_group.
|
|
4
|
+
*/
|
|
5
|
+
import type { Rule } from "eslint";
|
|
6
|
+
/** Rule implementation for requiring merge_group triggers. */
|
|
7
|
+
declare const rule: Rule.RuleModule;
|
|
8
|
+
export default rule;
|
|
9
|
+
//# sourceMappingURL=require-merge-group-trigger.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"require-merge-group-trigger.d.ts","sourceRoot":"","sources":["../../src/rules/require-merge-group-trigger.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAwCnC,8DAA8D;AAC9D,QAAA,MAAM,IAAI,EAAE,IAAI,CAAC,UAiDhB,CAAC;AAEF,eAAe,IAAI,CAAC"}
|
|
@@ -0,0 +1,65 @@
|
|
|
1
|
+
import { getMappingPair, getScalarStringValue, getWorkflowRoot, unwrapYamlValue, } from "../_internal/workflow-yaml.js";
|
|
2
|
+
/** Determine whether the workflow declares a specific trigger event. */
|
|
3
|
+
const hasTriggerEvent = (root, eventName) => {
|
|
4
|
+
const onPair = getMappingPair(root, "on");
|
|
5
|
+
const onValue = unwrapYamlValue(onPair?.value ?? null);
|
|
6
|
+
if (onValue === null) {
|
|
7
|
+
return false;
|
|
8
|
+
}
|
|
9
|
+
if (onValue.type === "YAMLScalar") {
|
|
10
|
+
return getScalarStringValue(onValue) === eventName;
|
|
11
|
+
}
|
|
12
|
+
if (onValue.type === "YAMLSequence") {
|
|
13
|
+
return onValue.entries.some((entry) => entry !== null && getScalarStringValue(entry) === eventName);
|
|
14
|
+
}
|
|
15
|
+
if (onValue.type !== "YAMLMapping") {
|
|
16
|
+
return false;
|
|
17
|
+
}
|
|
18
|
+
return getMappingPair(onValue, eventName) !== null;
|
|
19
|
+
};
|
|
20
|
+
/** Rule implementation for requiring merge_group triggers. */
|
|
21
|
+
const rule = {
|
|
22
|
+
create(context) {
|
|
23
|
+
return {
|
|
24
|
+
Program() {
|
|
25
|
+
const root = getWorkflowRoot(context);
|
|
26
|
+
if (root === null || !hasTriggerEvent(root, "pull_request")) {
|
|
27
|
+
return;
|
|
28
|
+
}
|
|
29
|
+
if (hasTriggerEvent(root, "merge_group")) {
|
|
30
|
+
return;
|
|
31
|
+
}
|
|
32
|
+
const onPair = getMappingPair(root, "on");
|
|
33
|
+
const onValue = unwrapYamlValue(onPair?.value ?? null);
|
|
34
|
+
if (onValue === null) {
|
|
35
|
+
return;
|
|
36
|
+
}
|
|
37
|
+
context.report({
|
|
38
|
+
messageId: "missingMergeGroup",
|
|
39
|
+
node: onValue,
|
|
40
|
+
});
|
|
41
|
+
},
|
|
42
|
+
};
|
|
43
|
+
},
|
|
44
|
+
meta: {
|
|
45
|
+
docs: {
|
|
46
|
+
configs: [
|
|
47
|
+
"github-actions.configs.all",
|
|
48
|
+
"github-actions.configs.strict",
|
|
49
|
+
],
|
|
50
|
+
description: "require pull-request validation workflows to include the `merge_group` trigger so required checks also run for merge queues.",
|
|
51
|
+
recommended: false,
|
|
52
|
+
requiresTypeChecking: false,
|
|
53
|
+
ruleId: "R035",
|
|
54
|
+
ruleNumber: 35,
|
|
55
|
+
url: "https://nick2bad4u.github.io/eslint-plugin-github-actions-2/docs/rules/require-merge-group-trigger",
|
|
56
|
+
},
|
|
57
|
+
messages: {
|
|
58
|
+
missingMergeGroup: "Workflows that validate pull requests should also listen to `merge_group` so required status checks are reported when pull requests enter a merge queue.",
|
|
59
|
+
},
|
|
60
|
+
schema: [],
|
|
61
|
+
type: "suggestion",
|
|
62
|
+
},
|
|
63
|
+
};
|
|
64
|
+
export default rule;
|
|
65
|
+
//# sourceMappingURL=require-merge-group-trigger.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"require-merge-group-trigger.js","sourceRoot":"","sources":["../../src/rules/require-merge-group-trigger.ts"],"names":[],"mappings":"AAOA,OAAO,EACH,cAAc,EACd,oBAAoB,EACpB,eAAe,EACf,eAAe,GAClB,MAAM,+BAA+B,CAAC;AAEvC,wEAAwE;AACxE,MAAM,eAAe,GAAG,CACpB,IAA+B,EAC/B,SAAiB,EACV,EAAE;IACT,MAAM,MAAM,GAAG,cAAc,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;IAC1C,MAAM,OAAO,GAAG,eAAe,CAAC,MAAM,EAAE,KAAK,IAAI,IAAI,CAAC,CAAC;IAEvD,IAAI,OAAO,KAAK,IAAI,EAAE,CAAC;QACnB,OAAO,KAAK,CAAC;IACjB,CAAC;IAED,IAAI,OAAO,CAAC,IAAI,KAAK,YAAY,EAAE,CAAC;QAChC,OAAO,oBAAoB,CAAC,OAAO,CAAC,KAAK,SAAS,CAAC;IACvD,CAAC;IAED,IAAI,OAAO,CAAC,IAAI,KAAK,cAAc,EAAE,CAAC;QAClC,OAAO,OAAO,CAAC,OAAO,CAAC,IAAI,CACvB,CAAC,KAAK,EAAE,EAAE,CACN,KAAK,KAAK,IAAI,IAAI,oBAAoB,CAAC,KAAK,CAAC,KAAK,SAAS,CAClE,CAAC;IACN,CAAC;IAED,IAAI,OAAO,CAAC,IAAI,KAAK,aAAa,EAAE,CAAC;QACjC,OAAO,KAAK,CAAC;IACjB,CAAC;IAED,OAAO,cAAc,CAAC,OAAO,EAAE,SAAS,CAAC,KAAK,IAAI,CAAC;AACvD,CAAC,CAAC;AAEF,8DAA8D;AAC9D,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,IAAI,CAAC,eAAe,CAAC,IAAI,EAAE,cAAc,CAAC,EAAE,CAAC;oBAC1D,OAAO;gBACX,CAAC;gBAED,IAAI,eAAe,CAAC,IAAI,EAAE,aAAa,CAAC,EAAE,CAAC;oBACvC,OAAO;gBACX,CAAC;gBAED,MAAM,MAAM,GAAG,cAAc,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;gBAC1C,MAAM,OAAO,GAAG,eAAe,CAAC,MAAM,EAAE,KAAK,IAAI,IAAI,CAAC,CAAC;gBAEvD,IAAI,OAAO,KAAK,IAAI,EAAE,CAAC;oBACnB,OAAO;gBACX,CAAC;gBAED,OAAO,CAAC,MAAM,CAAC;oBACX,SAAS,EAAE,mBAAmB;oBAC9B,IAAI,EAAE,OAA+B;iBACxC,CAAC,CAAC;YACP,CAAC;SACJ,CAAC;IACN,CAAC;IACD,IAAI,EAAE;QACF,IAAI,EAAE;YACF,OAAO,EAAE;gBACL,4BAA4B;gBAC5B,+BAA+B;aAClC;YACD,WAAW,EACP,8HAA8H;YAClI,WAAW,EAAE,KAAK;YAClB,oBAAoB,EAAE,KAAK;YAC3B,MAAM,EAAE,MAAM;YACd,UAAU,EAAE,EAAE;YACd,GAAG,EAAE,oGAAoG;SAC5G;QACD,QAAQ,EAAE;YACN,iBAAiB,EACb,0JAA0J;SACjK;QACD,MAAM,EAAE,EAAE;QACV,IAAI,EAAE,YAAY;KACA;CACzB,CAAC;AAEF,eAAe,IAAI,CAAC"}
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @packageDocumentation
|
|
3
|
+
* Require base-branch scoping for `pull_request_target` triggers.
|
|
4
|
+
*/
|
|
5
|
+
import type { Rule } from "eslint";
|
|
6
|
+
/** Rule implementation for requiring `pull_request_target` branch filters. */
|
|
7
|
+
declare const rule: Rule.RuleModule;
|
|
8
|
+
export default rule;
|
|
9
|
+
//# sourceMappingURL=require-pull-request-target-branches.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"require-pull-request-target-branches.d.ts","sourceRoot":"","sources":["../../src/rules/require-pull-request-target-branches.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAsCnC,8EAA8E;AAC9E,QAAA,MAAM,IAAI,EAAE,IAAI,CAAC,UAuHhB,CAAC;AAEF,eAAe,IAAI,CAAC"}
|
|
@@ -0,0 +1,102 @@
|
|
|
1
|
+
import { getMappingPair, getMappingValueAsMapping, getScalarStringValue, getWorkflowRoot, unwrapYamlValue, } from "../_internal/workflow-yaml.js";
|
|
2
|
+
/** Determine whether a branch filter node is meaningfully configured. */
|
|
3
|
+
const hasConfiguredBranchFilter = (node) => {
|
|
4
|
+
const valueNode = unwrapYamlValue(node?.value ?? null);
|
|
5
|
+
if (valueNode === null) {
|
|
6
|
+
return false;
|
|
7
|
+
}
|
|
8
|
+
if (valueNode.type === "YAMLScalar") {
|
|
9
|
+
const value = getScalarStringValue(valueNode);
|
|
10
|
+
return value !== null && value.trim().length > 0;
|
|
11
|
+
}
|
|
12
|
+
if (valueNode.type !== "YAMLSequence") {
|
|
13
|
+
return false;
|
|
14
|
+
}
|
|
15
|
+
return valueNode.entries.some((entry) => {
|
|
16
|
+
const value = getScalarStringValue(entry);
|
|
17
|
+
return value !== null && value.trim().length > 0;
|
|
18
|
+
});
|
|
19
|
+
};
|
|
20
|
+
/** Rule implementation for requiring `pull_request_target` branch filters. */
|
|
21
|
+
const rule = {
|
|
22
|
+
create(context) {
|
|
23
|
+
const reportMissingBranchFilter = (node) => {
|
|
24
|
+
context.report({
|
|
25
|
+
messageId: "missingBranchFilter",
|
|
26
|
+
node: node,
|
|
27
|
+
});
|
|
28
|
+
};
|
|
29
|
+
return {
|
|
30
|
+
Program() {
|
|
31
|
+
const root = getWorkflowRoot(context);
|
|
32
|
+
if (root === null) {
|
|
33
|
+
return;
|
|
34
|
+
}
|
|
35
|
+
const onPair = getMappingPair(root, "on");
|
|
36
|
+
const onValue = unwrapYamlValue(onPair?.value ?? null);
|
|
37
|
+
if (onValue === null) {
|
|
38
|
+
return;
|
|
39
|
+
}
|
|
40
|
+
if (onValue.type === "YAMLScalar") {
|
|
41
|
+
if (getScalarStringValue(onValue) === "pull_request_target") {
|
|
42
|
+
reportMissingBranchFilter(onValue);
|
|
43
|
+
}
|
|
44
|
+
return;
|
|
45
|
+
}
|
|
46
|
+
if (onValue.type === "YAMLSequence") {
|
|
47
|
+
for (const entry of onValue.entries) {
|
|
48
|
+
if (entry !== null &&
|
|
49
|
+
getScalarStringValue(entry) ===
|
|
50
|
+
"pull_request_target") {
|
|
51
|
+
reportMissingBranchFilter(entry);
|
|
52
|
+
}
|
|
53
|
+
}
|
|
54
|
+
return;
|
|
55
|
+
}
|
|
56
|
+
const onMapping = getMappingValueAsMapping(root, "on");
|
|
57
|
+
if (onMapping === null) {
|
|
58
|
+
return;
|
|
59
|
+
}
|
|
60
|
+
const pullRequestTargetPair = getMappingPair(onMapping, "pull_request_target");
|
|
61
|
+
const pullRequestTargetValue = unwrapYamlValue(pullRequestTargetPair?.value ?? null);
|
|
62
|
+
if (pullRequestTargetPair === null) {
|
|
63
|
+
return;
|
|
64
|
+
}
|
|
65
|
+
if (pullRequestTargetValue?.type !== "YAMLMapping") {
|
|
66
|
+
reportMissingBranchFilter((pullRequestTargetPair.value ??
|
|
67
|
+
pullRequestTargetPair));
|
|
68
|
+
return;
|
|
69
|
+
}
|
|
70
|
+
const branchesPair = getMappingPair(pullRequestTargetValue, "branches");
|
|
71
|
+
const branchesIgnorePair = getMappingPair(pullRequestTargetValue, "branches-ignore");
|
|
72
|
+
if (hasConfiguredBranchFilter(branchesPair) ||
|
|
73
|
+
hasConfiguredBranchFilter(branchesIgnorePair)) {
|
|
74
|
+
return;
|
|
75
|
+
}
|
|
76
|
+
reportMissingBranchFilter(pullRequestTargetValue);
|
|
77
|
+
},
|
|
78
|
+
};
|
|
79
|
+
},
|
|
80
|
+
meta: {
|
|
81
|
+
docs: {
|
|
82
|
+
configs: [
|
|
83
|
+
"github-actions.configs.all",
|
|
84
|
+
"github-actions.configs.security",
|
|
85
|
+
"github-actions.configs.strict",
|
|
86
|
+
],
|
|
87
|
+
description: "require `on.pull_request_target` triggers to scope target base branches with `branches` or `branches-ignore` so privileged workflows do not react to every branch by default.",
|
|
88
|
+
recommended: false,
|
|
89
|
+
requiresTypeChecking: false,
|
|
90
|
+
ruleId: "R032",
|
|
91
|
+
ruleNumber: 32,
|
|
92
|
+
url: "https://nick2bad4u.github.io/eslint-plugin-github-actions-2/docs/rules/require-pull-request-target-branches",
|
|
93
|
+
},
|
|
94
|
+
messages: {
|
|
95
|
+
missingBranchFilter: "`on.pull_request_target` should declare a non-empty `branches` or `branches-ignore` filter to scope which base branches can trigger this privileged workflow.",
|
|
96
|
+
},
|
|
97
|
+
schema: [],
|
|
98
|
+
type: "suggestion",
|
|
99
|
+
},
|
|
100
|
+
};
|
|
101
|
+
export default rule;
|
|
102
|
+
//# sourceMappingURL=require-pull-request-target-branches.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"require-pull-request-target-branches.js","sourceRoot":"","sources":["../../src/rules/require-pull-request-target-branches.ts"],"names":[],"mappings":"AAOA,OAAO,EACH,cAAc,EACd,wBAAwB,EACxB,oBAAoB,EACpB,eAAe,EACf,eAAe,GAClB,MAAM,+BAA+B,CAAC;AAEvC,yEAAyE;AACzE,MAAM,yBAAyB,GAAG,CAC9B,IAA+C,EACxC,EAAE;IACT,MAAM,SAAS,GAAG,eAAe,CAAC,IAAI,EAAE,KAAK,IAAI,IAAI,CAAC,CAAC;IAEvD,IAAI,SAAS,KAAK,IAAI,EAAE,CAAC;QACrB,OAAO,KAAK,CAAC;IACjB,CAAC;IAED,IAAI,SAAS,CAAC,IAAI,KAAK,YAAY,EAAE,CAAC;QAClC,MAAM,KAAK,GAAG,oBAAoB,CAAC,SAAS,CAAC,CAAC;QAE9C,OAAO,KAAK,KAAK,IAAI,IAAI,KAAK,CAAC,IAAI,EAAE,CAAC,MAAM,GAAG,CAAC,CAAC;IACrD,CAAC;IAED,IAAI,SAAS,CAAC,IAAI,KAAK,cAAc,EAAE,CAAC;QACpC,OAAO,KAAK,CAAC;IACjB,CAAC;IAED,OAAO,SAAS,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE;QACpC,MAAM,KAAK,GAAG,oBAAoB,CAAC,KAAK,CAAC,CAAC;QAE1C,OAAO,KAAK,KAAK,IAAI,IAAI,KAAK,CAAC,IAAI,EAAE,CAAC,MAAM,GAAG,CAAC,CAAC;IACrD,CAAC,CAAC,CAAC;AACP,CAAC,CAAC;AAEF,8EAA8E;AAC9E,MAAM,IAAI,GAAoB;IAC1B,MAAM,CAAC,OAAO;QACV,MAAM,yBAAyB,GAAG,CAC9B,IAA4B,EACxB,EAAE;YACN,OAAO,CAAC,MAAM,CAAC;gBACX,SAAS,EAAE,qBAAqB;gBAChC,IAAI,EAAE,IAA4B;aACrC,CAAC,CAAC;QACP,CAAC,CAAC;QAEF,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,MAAM,GAAG,cAAc,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;gBAC1C,MAAM,OAAO,GAAG,eAAe,CAAC,MAAM,EAAE,KAAK,IAAI,IAAI,CAAC,CAAC;gBAEvD,IAAI,OAAO,KAAK,IAAI,EAAE,CAAC;oBACnB,OAAO;gBACX,CAAC;gBAED,IAAI,OAAO,CAAC,IAAI,KAAK,YAAY,EAAE,CAAC;oBAChC,IACI,oBAAoB,CAAC,OAAO,CAAC,KAAK,qBAAqB,EACzD,CAAC;wBACC,yBAAyB,CAAC,OAAO,CAAC,CAAC;oBACvC,CAAC;oBAED,OAAO;gBACX,CAAC;gBAED,IAAI,OAAO,CAAC,IAAI,KAAK,cAAc,EAAE,CAAC;oBAClC,KAAK,MAAM,KAAK,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC;wBAClC,IACI,KAAK,KAAK,IAAI;4BACd,oBAAoB,CAAC,KAAK,CAAC;gCACvB,qBAAqB,EAC3B,CAAC;4BACC,yBAAyB,CAAC,KAAK,CAAC,CAAC;wBACrC,CAAC;oBACL,CAAC;oBAED,OAAO;gBACX,CAAC;gBAED,MAAM,SAAS,GAAG,wBAAwB,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;gBAEvD,IAAI,SAAS,KAAK,IAAI,EAAE,CAAC;oBACrB,OAAO;gBACX,CAAC;gBAED,MAAM,qBAAqB,GAAG,cAAc,CACxC,SAAS,EACT,qBAAqB,CACxB,CAAC;gBACF,MAAM,sBAAsB,GAAG,eAAe,CAC1C,qBAAqB,EAAE,KAAK,IAAI,IAAI,CACvC,CAAC;gBAEF,IAAI,qBAAqB,KAAK,IAAI,EAAE,CAAC;oBACjC,OAAO;gBACX,CAAC;gBAED,IAAI,sBAAsB,EAAE,IAAI,KAAK,aAAa,EAAE,CAAC;oBACjD,yBAAyB,CACrB,CAAC,qBAAqB,CAAC,KAAK;wBACxB,qBAAqB,CAAiB,CAC7C,CAAC;oBAEF,OAAO;gBACX,CAAC;gBAED,MAAM,YAAY,GAAG,cAAc,CAC/B,sBAAsB,EACtB,UAAU,CACb,CAAC;gBACF,MAAM,kBAAkB,GAAG,cAAc,CACrC,sBAAsB,EACtB,iBAAiB,CACpB,CAAC;gBAEF,IACI,yBAAyB,CAAC,YAAY,CAAC;oBACvC,yBAAyB,CAAC,kBAAkB,CAAC,EAC/C,CAAC;oBACC,OAAO;gBACX,CAAC;gBAED,yBAAyB,CAAC,sBAAsB,CAAC,CAAC;YACtD,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,+KAA+K;YACnL,WAAW,EAAE,KAAK;YAClB,oBAAoB,EAAE,KAAK;YAC3B,MAAM,EAAE,MAAM;YACd,UAAU,EAAE,EAAE;YACd,GAAG,EAAE,6GAA6G;SACrH;QACD,QAAQ,EAAE;YACN,mBAAmB,EACf,+JAA+J;SACtK;QACD,MAAM,EAAE,EAAE;QACV,IAAI,EAAE,YAAY;KACA;CACzB,CAAC;AAEF,eAAe,IAAI,CAAC"}
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @packageDocumentation
|
|
3
|
+
* Require `run` steps to declare an explicit shell directly or through defaults.
|
|
4
|
+
*/
|
|
5
|
+
import type { Rule } from "eslint";
|
|
6
|
+
/** Rule implementation for requiring explicit shells on run steps. */
|
|
7
|
+
declare const rule: Rule.RuleModule;
|
|
8
|
+
export default rule;
|
|
9
|
+
//# sourceMappingURL=require-run-step-shell.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"require-run-step-shell.d.ts","sourceRoot":"","sources":["../../src/rules/require-run-step-shell.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAgDnC,sEAAsE;AACtE,QAAA,MAAM,IAAI,EAAE,IAAI,CAAC,UAsIhB,CAAC;AAEF,eAAe,IAAI,CAAC"}
|
|
@@ -0,0 +1,114 @@
|
|
|
1
|
+
import { getMappingPair, getMappingValueAsMapping, getMappingValueAsSequence, getScalarStringValue, getWorkflowJobs, getWorkflowRoot, unwrapYamlValue, } from "../_internal/workflow-yaml.js";
|
|
2
|
+
/** Inspect a shell pair and determine whether it is usable. */
|
|
3
|
+
const getShellDeclarationState = (shellPair) => {
|
|
4
|
+
if (shellPair === null) {
|
|
5
|
+
return "missing";
|
|
6
|
+
}
|
|
7
|
+
const shellValue = getScalarStringValue(shellPair.value);
|
|
8
|
+
return shellValue !== null && shellValue.trim().length > 0
|
|
9
|
+
? "valid"
|
|
10
|
+
: "invalid";
|
|
11
|
+
};
|
|
12
|
+
/** Resolve `defaults.run.shell` from a mapping when present. */
|
|
13
|
+
const getRunDefaultsShellPair = (mapping) => {
|
|
14
|
+
const defaultsMapping = getMappingValueAsMapping(mapping, "defaults");
|
|
15
|
+
if (defaultsMapping === null) {
|
|
16
|
+
return null;
|
|
17
|
+
}
|
|
18
|
+
const runDefaultsMapping = getMappingValueAsMapping(defaultsMapping, "run");
|
|
19
|
+
return runDefaultsMapping === null
|
|
20
|
+
? null
|
|
21
|
+
: getMappingPair(runDefaultsMapping, "shell");
|
|
22
|
+
};
|
|
23
|
+
/** Rule implementation for requiring explicit shells on run steps. */
|
|
24
|
+
const rule = {
|
|
25
|
+
create(context) {
|
|
26
|
+
const reportInvalidShell = (shellPair, scope) => {
|
|
27
|
+
context.report({
|
|
28
|
+
data: {
|
|
29
|
+
scope,
|
|
30
|
+
},
|
|
31
|
+
messageId: "invalidShell",
|
|
32
|
+
node: (shellPair.value ?? shellPair),
|
|
33
|
+
});
|
|
34
|
+
};
|
|
35
|
+
return {
|
|
36
|
+
Program() {
|
|
37
|
+
const root = getWorkflowRoot(context);
|
|
38
|
+
if (root === null) {
|
|
39
|
+
return;
|
|
40
|
+
}
|
|
41
|
+
const workflowShellPair = getRunDefaultsShellPair(root);
|
|
42
|
+
const workflowShellState = getShellDeclarationState(workflowShellPair);
|
|
43
|
+
if (workflowShellPair !== null &&
|
|
44
|
+
workflowShellState === "invalid") {
|
|
45
|
+
reportInvalidShell(workflowShellPair, "workflow `defaults.run.shell`");
|
|
46
|
+
}
|
|
47
|
+
for (const job of getWorkflowJobs(root)) {
|
|
48
|
+
const jobShellPair = getRunDefaultsShellPair(job.mapping);
|
|
49
|
+
const jobShellState = getShellDeclarationState(jobShellPair);
|
|
50
|
+
if (jobShellPair !== null && jobShellState === "invalid") {
|
|
51
|
+
reportInvalidShell(jobShellPair, `job '${job.id}' defaults.run.shell`);
|
|
52
|
+
}
|
|
53
|
+
const stepsSequence = getMappingValueAsSequence(job.mapping, "steps");
|
|
54
|
+
if (stepsSequence === null) {
|
|
55
|
+
continue;
|
|
56
|
+
}
|
|
57
|
+
for (const entry of stepsSequence.entries) {
|
|
58
|
+
const stepMapping = unwrapYamlValue(entry);
|
|
59
|
+
if (stepMapping?.type !== "YAMLMapping") {
|
|
60
|
+
continue;
|
|
61
|
+
}
|
|
62
|
+
const runPair = getMappingPair(stepMapping, "run");
|
|
63
|
+
if (runPair === null) {
|
|
64
|
+
continue;
|
|
65
|
+
}
|
|
66
|
+
const stepShellPair = getMappingPair(stepMapping, "shell");
|
|
67
|
+
const stepShellState = getShellDeclarationState(stepShellPair);
|
|
68
|
+
if (stepShellPair !== null) {
|
|
69
|
+
if (stepShellState === "valid") {
|
|
70
|
+
continue;
|
|
71
|
+
}
|
|
72
|
+
reportInvalidShell(stepShellPair, `a run step in job '${job.id}'`);
|
|
73
|
+
continue;
|
|
74
|
+
}
|
|
75
|
+
if (jobShellState !== "missing" ||
|
|
76
|
+
workflowShellState !== "missing") {
|
|
77
|
+
continue;
|
|
78
|
+
}
|
|
79
|
+
context.report({
|
|
80
|
+
data: {
|
|
81
|
+
jobId: job.id,
|
|
82
|
+
},
|
|
83
|
+
messageId: "missingShell",
|
|
84
|
+
node: (runPair.value ??
|
|
85
|
+
stepMapping),
|
|
86
|
+
});
|
|
87
|
+
}
|
|
88
|
+
}
|
|
89
|
+
},
|
|
90
|
+
};
|
|
91
|
+
},
|
|
92
|
+
meta: {
|
|
93
|
+
docs: {
|
|
94
|
+
configs: [
|
|
95
|
+
"github-actions.configs.all",
|
|
96
|
+
"github-actions.configs.strict",
|
|
97
|
+
],
|
|
98
|
+
description: "require `run` steps to use an explicit shell directly or through `defaults.run.shell` so execution behavior stays predictable across runners.",
|
|
99
|
+
recommended: false,
|
|
100
|
+
requiresTypeChecking: false,
|
|
101
|
+
ruleId: "R021",
|
|
102
|
+
ruleNumber: 21,
|
|
103
|
+
url: "https://nick2bad4u.github.io/eslint-plugin-github-actions-2/docs/rules/require-run-step-shell",
|
|
104
|
+
},
|
|
105
|
+
messages: {
|
|
106
|
+
invalidShell: "{{scope}} must set `shell` to a non-empty string when declared.",
|
|
107
|
+
missingShell: "A `run` step in job '{{jobId}}' should declare `shell` explicitly or inherit it from `defaults.run.shell`.",
|
|
108
|
+
},
|
|
109
|
+
schema: [],
|
|
110
|
+
type: "suggestion",
|
|
111
|
+
},
|
|
112
|
+
};
|
|
113
|
+
export default rule;
|
|
114
|
+
//# sourceMappingURL=require-run-step-shell.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"require-run-step-shell.js","sourceRoot":"","sources":["../../src/rules/require-run-step-shell.ts"],"names":[],"mappings":"AAOA,OAAO,EACH,cAAc,EACd,wBAAwB,EACxB,yBAAyB,EACzB,oBAAoB,EACpB,eAAe,EACf,eAAe,EACf,eAAe,GAClB,MAAM,+BAA+B,CAAC;AAKvC,+DAA+D;AAC/D,MAAM,wBAAwB,GAAG,CAC7B,SAAwC,EACnB,EAAE;IACvB,IAAI,SAAS,KAAK,IAAI,EAAE,CAAC;QACrB,OAAO,SAAS,CAAC;IACrB,CAAC;IAED,MAAM,UAAU,GAAG,oBAAoB,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;IAEzD,OAAO,UAAU,KAAK,IAAI,IAAI,UAAU,CAAC,IAAI,EAAE,CAAC,MAAM,GAAG,CAAC;QACtD,CAAC,CAAC,OAAO;QACT,CAAC,CAAC,SAAS,CAAC;AACpB,CAAC,CAAC;AAEF,gEAAgE;AAChE,MAAM,uBAAuB,GAAG,CAC5B,OAAkC,EACf,EAAE;IACrB,MAAM,eAAe,GAAG,wBAAwB,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC;IAEtE,IAAI,eAAe,KAAK,IAAI,EAAE,CAAC;QAC3B,OAAO,IAAI,CAAC;IAChB,CAAC;IAED,MAAM,kBAAkB,GAAG,wBAAwB,CAAC,eAAe,EAAE,KAAK,CAAC,CAAC;IAE5E,OAAO,kBAAkB,KAAK,IAAI;QAC9B,CAAC,CAAC,IAAI;QACN,CAAC,CAAC,cAAc,CAAC,kBAAkB,EAAE,OAAO,CAAC,CAAC;AACtD,CAAC,CAAC;AAEF,sEAAsE;AACtE,MAAM,IAAI,GAAoB;IAC1B,MAAM,CAAC,OAAO;QACV,MAAM,kBAAkB,GAAG,CACvB,SAAiC,EACjC,KAAa,EACT,EAAE;YACN,OAAO,CAAC,MAAM,CAAC;gBACX,IAAI,EAAE;oBACF,KAAK;iBACR;gBACD,SAAS,EAAE,cAAc;gBACzB,IAAI,EAAE,CAAC,SAAS,CAAC,KAAK,IAAI,SAAS,CAAyB;aAC/D,CAAC,CAAC;QACP,CAAC,CAAC;QAEF,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,iBAAiB,GAAG,uBAAuB,CAAC,IAAI,CAAC,CAAC;gBACxD,MAAM,kBAAkB,GACpB,wBAAwB,CAAC,iBAAiB,CAAC,CAAC;gBAEhD,IACI,iBAAiB,KAAK,IAAI;oBAC1B,kBAAkB,KAAK,SAAS,EAClC,CAAC;oBACC,kBAAkB,CACd,iBAAiB,EACjB,+BAA+B,CAClC,CAAC;gBACN,CAAC;gBAED,KAAK,MAAM,GAAG,IAAI,eAAe,CAAC,IAAI,CAAC,EAAE,CAAC;oBACtC,MAAM,YAAY,GAAG,uBAAuB,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;oBAC1D,MAAM,aAAa,GACf,wBAAwB,CAAC,YAAY,CAAC,CAAC;oBAE3C,IAAI,YAAY,KAAK,IAAI,IAAI,aAAa,KAAK,SAAS,EAAE,CAAC;wBACvD,kBAAkB,CACd,YAAY,EACZ,QAAQ,GAAG,CAAC,EAAE,sBAAsB,CACvC,CAAC;oBACN,CAAC;oBAED,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;wBAEnD,IAAI,OAAO,KAAK,IAAI,EAAE,CAAC;4BACnB,SAAS;wBACb,CAAC;wBAED,MAAM,aAAa,GAAG,cAAc,CAChC,WAAW,EACX,OAAO,CACV,CAAC;wBACF,MAAM,cAAc,GAChB,wBAAwB,CAAC,aAAa,CAAC,CAAC;wBAE5C,IAAI,aAAa,KAAK,IAAI,EAAE,CAAC;4BACzB,IAAI,cAAc,KAAK,OAAO,EAAE,CAAC;gCAC7B,SAAS;4BACb,CAAC;4BAED,kBAAkB,CACd,aAAa,EACb,sBAAsB,GAAG,CAAC,EAAE,GAAG,CAClC,CAAC;4BAEF,SAAS;wBACb,CAAC;wBAED,IACI,aAAa,KAAK,SAAS;4BAC3B,kBAAkB,KAAK,SAAS,EAClC,CAAC;4BACC,SAAS;wBACb,CAAC;wBAED,OAAO,CAAC,MAAM,CAAC;4BACX,IAAI,EAAE;gCACF,KAAK,EAAE,GAAG,CAAC,EAAE;6BAChB;4BACD,SAAS,EAAE,cAAc;4BACzB,IAAI,EAAE,CAAC,OAAO,CAAC,KAAK;gCAChB,WAAW,CAAyB;yBAC3C,CAAC,CAAC;oBACP,CAAC;gBACL,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,+IAA+I;YACnJ,WAAW,EAAE,KAAK;YAClB,oBAAoB,EAAE,KAAK;YAC3B,MAAM,EAAE,MAAM;YACd,UAAU,EAAE,EAAE;YACd,GAAG,EAAE,+FAA+F;SACvG;QACD,QAAQ,EAAE;YACN,YAAY,EACR,iEAAiE;YACrE,YAAY,EACR,4GAA4G;SACnH;QACD,MAAM,EAAE,EAAE;QACV,IAAI,EAAE,YAAY;KACA;CACzB,CAAC;AAEF,eAAe,IAAI,CAAC"}
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @packageDocumentation
|
|
3
|
+
* Require `categories` in workflow-template properties metadata.
|
|
4
|
+
*/
|
|
5
|
+
import type { Rule } from "eslint";
|
|
6
|
+
/** Rule implementation for requiring template categories. */
|
|
7
|
+
declare const rule: Rule.RuleModule;
|
|
8
|
+
export default rule;
|
|
9
|
+
//# sourceMappingURL=require-template-categories.d.ts.map
|