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,84 @@
|
|
|
1
|
+
import { getMappingPair, getMappingValueAsMapping, getScalarStringValue, getWorkflowRoot, unwrapYamlValue, } from "../_internal/workflow-yaml.js";
|
|
2
|
+
/**
|
|
3
|
+
* Determine whether a workflow_run branch filter node is meaningfully
|
|
4
|
+
* configured.
|
|
5
|
+
*/
|
|
6
|
+
const hasConfiguredBranchFilter = (node) => {
|
|
7
|
+
const valueNode = unwrapYamlValue(node?.value ?? null);
|
|
8
|
+
if (valueNode === null) {
|
|
9
|
+
return false;
|
|
10
|
+
}
|
|
11
|
+
if (valueNode.type === "YAMLScalar") {
|
|
12
|
+
const value = getScalarStringValue(valueNode);
|
|
13
|
+
return value !== null && value.trim().length > 0;
|
|
14
|
+
}
|
|
15
|
+
if (valueNode.type !== "YAMLSequence") {
|
|
16
|
+
return false;
|
|
17
|
+
}
|
|
18
|
+
return valueNode.entries.some((entry) => {
|
|
19
|
+
const value = getScalarStringValue(entry);
|
|
20
|
+
return value !== null && value.trim().length > 0;
|
|
21
|
+
});
|
|
22
|
+
};
|
|
23
|
+
/** Rule implementation for requiring `workflow_run` branch filters. */
|
|
24
|
+
const rule = {
|
|
25
|
+
create(context) {
|
|
26
|
+
return {
|
|
27
|
+
Program() {
|
|
28
|
+
const root = getWorkflowRoot(context);
|
|
29
|
+
if (root === null) {
|
|
30
|
+
return;
|
|
31
|
+
}
|
|
32
|
+
const onMapping = getMappingValueAsMapping(root, "on");
|
|
33
|
+
if (onMapping === null) {
|
|
34
|
+
return;
|
|
35
|
+
}
|
|
36
|
+
const workflowRunPair = getMappingPair(onMapping, "workflow_run");
|
|
37
|
+
const workflowRunMapping = unwrapYamlValue(workflowRunPair?.value ?? null);
|
|
38
|
+
if (workflowRunPair === null) {
|
|
39
|
+
return;
|
|
40
|
+
}
|
|
41
|
+
if (workflowRunMapping?.type !== "YAMLMapping") {
|
|
42
|
+
context.report({
|
|
43
|
+
messageId: "missingBranchFilter",
|
|
44
|
+
node: (workflowRunPair.value ??
|
|
45
|
+
workflowRunPair),
|
|
46
|
+
});
|
|
47
|
+
return;
|
|
48
|
+
}
|
|
49
|
+
const branchesPair = getMappingPair(workflowRunMapping, "branches");
|
|
50
|
+
const branchesIgnorePair = getMappingPair(workflowRunMapping, "branches-ignore");
|
|
51
|
+
if (hasConfiguredBranchFilter(branchesPair) ||
|
|
52
|
+
hasConfiguredBranchFilter(branchesIgnorePair)) {
|
|
53
|
+
return;
|
|
54
|
+
}
|
|
55
|
+
context.report({
|
|
56
|
+
messageId: "missingBranchFilter",
|
|
57
|
+
node: workflowRunMapping,
|
|
58
|
+
});
|
|
59
|
+
},
|
|
60
|
+
};
|
|
61
|
+
},
|
|
62
|
+
meta: {
|
|
63
|
+
docs: {
|
|
64
|
+
configs: [
|
|
65
|
+
"github-actions.configs.all",
|
|
66
|
+
"github-actions.configs.security",
|
|
67
|
+
"github-actions.configs.strict",
|
|
68
|
+
],
|
|
69
|
+
description: "require `on.workflow_run` triggers to scope upstream branches with `branches` or `branches-ignore` so follow-up workflows do not react to every branch indiscriminately.",
|
|
70
|
+
recommended: false,
|
|
71
|
+
requiresTypeChecking: false,
|
|
72
|
+
ruleId: "R028",
|
|
73
|
+
ruleNumber: 28,
|
|
74
|
+
url: "https://nick2bad4u.github.io/eslint-plugin-github-actions-2/docs/rules/require-workflow-run-branches",
|
|
75
|
+
},
|
|
76
|
+
messages: {
|
|
77
|
+
missingBranchFilter: "`on.workflow_run` should declare a non-empty `branches` or `branches-ignore` filter to scope which upstream branches can trigger this workflow.",
|
|
78
|
+
},
|
|
79
|
+
schema: [],
|
|
80
|
+
type: "suggestion",
|
|
81
|
+
},
|
|
82
|
+
};
|
|
83
|
+
export default rule;
|
|
84
|
+
//# sourceMappingURL=require-workflow-run-branches.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"require-workflow-run-branches.js","sourceRoot":"","sources":["../../src/rules/require-workflow-run-branches.ts"],"names":[],"mappings":"AAOA,OAAO,EACH,cAAc,EACd,wBAAwB,EACxB,oBAAoB,EACpB,eAAe,EACf,eAAe,GAClB,MAAM,+BAA+B,CAAC;AAEvC;;;GAGG;AACH,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,uEAAuE;AACvE,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,SAAS,GAAG,wBAAwB,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;gBAEvD,IAAI,SAAS,KAAK,IAAI,EAAE,CAAC;oBACrB,OAAO;gBACX,CAAC;gBAED,MAAM,eAAe,GAAG,cAAc,CAClC,SAAS,EACT,cAAc,CACjB,CAAC;gBACF,MAAM,kBAAkB,GAAG,eAAe,CACtC,eAAe,EAAE,KAAK,IAAI,IAAI,CACjC,CAAC;gBAEF,IAAI,eAAe,KAAK,IAAI,EAAE,CAAC;oBAC3B,OAAO;gBACX,CAAC;gBAED,IAAI,kBAAkB,EAAE,IAAI,KAAK,aAAa,EAAE,CAAC;oBAC7C,OAAO,CAAC,MAAM,CAAC;wBACX,SAAS,EAAE,qBAAqB;wBAChC,IAAI,EAAE,CAAC,eAAe,CAAC,KAAK;4BACxB,eAAe,CAAyB;qBAC/C,CAAC,CAAC;oBAEH,OAAO;gBACX,CAAC;gBAED,MAAM,YAAY,GAAG,cAAc,CAC/B,kBAAkB,EAClB,UAAU,CACb,CAAC;gBACF,MAAM,kBAAkB,GAAG,cAAc,CACrC,kBAAkB,EAClB,iBAAiB,CACpB,CAAC;gBAEF,IACI,yBAAyB,CAAC,YAAY,CAAC;oBACvC,yBAAyB,CAAC,kBAAkB,CAAC,EAC/C,CAAC;oBACC,OAAO;gBACX,CAAC;gBAED,OAAO,CAAC,MAAM,CAAC;oBACX,SAAS,EAAE,qBAAqB;oBAChC,IAAI,EAAE,kBAA0C;iBACnD,CAAC,CAAC;YACP,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,0KAA0K;YAC9K,WAAW,EAAE,KAAK;YAClB,oBAAoB,EAAE,KAAK;YAC3B,MAAM,EAAE,MAAM;YACd,UAAU,EAAE,EAAE;YACd,GAAG,EAAE,sGAAsG;SAC9G;QACD,QAAQ,EAAE;YACN,mBAAmB,EACf,iJAAiJ;SACxJ;QACD,MAAM,EAAE,EAAE;QACV,IAAI,EAAE,YAAY;KACA;CACzB,CAAC;AAEF,eAAe,IAAI,CAAC"}
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @packageDocumentation
|
|
3
|
+
* Require each workflow template YAML file to have a paired `.properties.json` metadata file.
|
|
4
|
+
*/
|
|
5
|
+
import type { Rule } from "eslint";
|
|
6
|
+
/** Rule implementation for workflow-template YAML pair checks. */
|
|
7
|
+
declare const rule: Rule.RuleModule;
|
|
8
|
+
export default rule;
|
|
9
|
+
//# sourceMappingURL=require-workflow-template-pair.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"require-workflow-template-pair.d.ts","sourceRoot":"","sources":["../../src/rules/require-workflow-template-pair.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAOnC,kEAAkE;AAClE,QAAA,MAAM,IAAI,EAAE,IAAI,CAAC,UA+ChB,CAAC;AAEF,eAAe,IAAI,CAAC"}
|
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
import { existsSync } from "node:fs";
|
|
2
|
+
import { isWorkflowTemplateYamlFile } from "../_internal/lint-targets.js";
|
|
3
|
+
import { getPairedTemplatePropertiesPath } from "../_internal/workflow-template-properties.js";
|
|
4
|
+
/** Rule implementation for workflow-template YAML pair checks. */
|
|
5
|
+
const rule = {
|
|
6
|
+
create(context) {
|
|
7
|
+
return {
|
|
8
|
+
Program(node) {
|
|
9
|
+
if (!isWorkflowTemplateYamlFile(context.filename)) {
|
|
10
|
+
return;
|
|
11
|
+
}
|
|
12
|
+
const pairedPropertiesPath = getPairedTemplatePropertiesPath(context.filename);
|
|
13
|
+
if (existsSync(pairedPropertiesPath)) {
|
|
14
|
+
return;
|
|
15
|
+
}
|
|
16
|
+
context.report({
|
|
17
|
+
data: {
|
|
18
|
+
pairedPropertiesPath,
|
|
19
|
+
},
|
|
20
|
+
messageId: "missingTemplatePropertiesPair",
|
|
21
|
+
node: node,
|
|
22
|
+
});
|
|
23
|
+
},
|
|
24
|
+
};
|
|
25
|
+
},
|
|
26
|
+
meta: {
|
|
27
|
+
docs: {
|
|
28
|
+
configs: [
|
|
29
|
+
"github-actions.configs.workflowTemplates",
|
|
30
|
+
"github-actions.configs.all",
|
|
31
|
+
],
|
|
32
|
+
description: "require each workflow template YAML file to have a matching `.properties.json` metadata file.",
|
|
33
|
+
recommended: true,
|
|
34
|
+
requiresTypeChecking: false,
|
|
35
|
+
ruleId: "R054",
|
|
36
|
+
ruleNumber: 54,
|
|
37
|
+
url: "https://nick2bad4u.github.io/eslint-plugin-github-actions-2/docs/rules/require-workflow-template-pair",
|
|
38
|
+
},
|
|
39
|
+
messages: {
|
|
40
|
+
missingTemplatePropertiesPair: "Workflow template file is missing its paired metadata file '{{pairedPropertiesPath}}'.",
|
|
41
|
+
},
|
|
42
|
+
schema: [],
|
|
43
|
+
type: "problem",
|
|
44
|
+
},
|
|
45
|
+
};
|
|
46
|
+
export default rule;
|
|
47
|
+
//# sourceMappingURL=require-workflow-template-pair.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"require-workflow-template-pair.js","sourceRoot":"","sources":["../../src/rules/require-workflow-template-pair.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,UAAU,EAAE,MAAM,SAAS,CAAC;AAErC,OAAO,EAAE,0BAA0B,EAAE,MAAM,8BAA8B,CAAC;AAC1E,OAAO,EAAE,+BAA+B,EAAE,MAAM,8CAA8C,CAAC;AAE/F,kEAAkE;AAClE,MAAM,IAAI,GAAoB;IAC1B,MAAM,CAAC,OAAO;QACV,OAAO;YACH,OAAO,CAAC,IAAI;gBACR,IAAI,CAAC,0BAA0B,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC;oBAChD,OAAO;gBACX,CAAC;gBAED,MAAM,oBAAoB,GAAG,+BAA+B,CACxD,OAAO,CAAC,QAAQ,CACnB,CAAC;gBAEF,IAAI,UAAU,CAAC,oBAAoB,CAAC,EAAE,CAAC;oBACnC,OAAO;gBACX,CAAC;gBAED,OAAO,CAAC,MAAM,CAAC;oBACX,IAAI,EAAE;wBACF,oBAAoB;qBACvB;oBACD,SAAS,EAAE,+BAA+B;oBAC1C,IAAI,EAAE,IAA4B;iBACrC,CAAC,CAAC;YACP,CAAC;SACJ,CAAC;IACN,CAAC;IACD,IAAI,EAAE;QACF,IAAI,EAAE;YACF,OAAO,EAAE;gBACL,0CAA0C;gBAC1C,4BAA4B;aAC/B;YACD,WAAW,EACP,+FAA+F;YACnG,WAAW,EAAE,IAAI;YACjB,oBAAoB,EAAE,KAAK;YAC3B,MAAM,EAAE,MAAM;YACd,UAAU,EAAE,EAAE;YACd,GAAG,EAAE,uGAAuG;SAC/G;QACD,QAAQ,EAAE;YACN,6BAA6B,EACzB,wFAAwF;SAC/F;QACD,MAAM,EAAE,EAAE;QACV,IAAI,EAAE,SAAS;KACG;CACzB,CAAC;AAEF,eAAe,IAAI,CAAC"}
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @packageDocumentation
|
|
3
|
+
* Require each workflow template properties file to have a paired template YAML file.
|
|
4
|
+
*/
|
|
5
|
+
import type { Rule } from "eslint";
|
|
6
|
+
/** Rule implementation for template metadata pair checks. */
|
|
7
|
+
declare const rule: Rule.RuleModule;
|
|
8
|
+
export default rule;
|
|
9
|
+
//# sourceMappingURL=require-workflow-template-properties-pair.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"require-workflow-template-properties-pair.d.ts","sourceRoot":"","sources":["../../src/rules/require-workflow-template-properties-pair.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAOnC,6DAA6D;AAC7D,QAAA,MAAM,IAAI,EAAE,IAAI,CAAC,UAgDhB,CAAC;AAEF,eAAe,IAAI,CAAC"}
|
|
@@ -0,0 +1,49 @@
|
|
|
1
|
+
import { existsSync } from "node:fs";
|
|
2
|
+
import { isWorkflowTemplatePropertiesFile } from "../_internal/lint-targets.js";
|
|
3
|
+
import { getPairedTemplateYamlPaths } from "../_internal/workflow-template-properties.js";
|
|
4
|
+
/** Rule implementation for template metadata pair checks. */
|
|
5
|
+
const rule = {
|
|
6
|
+
create(context) {
|
|
7
|
+
return {
|
|
8
|
+
Program(node) {
|
|
9
|
+
if (!isWorkflowTemplatePropertiesFile(context.filename)) {
|
|
10
|
+
return;
|
|
11
|
+
}
|
|
12
|
+
const [pairedYmlPath, pairedYamlPath] = getPairedTemplateYamlPaths(context.filename);
|
|
13
|
+
if (existsSync(pairedYmlPath) || existsSync(pairedYamlPath)) {
|
|
14
|
+
return;
|
|
15
|
+
}
|
|
16
|
+
context.report({
|
|
17
|
+
data: {
|
|
18
|
+
pairedYamlPath,
|
|
19
|
+
pairedYmlPath,
|
|
20
|
+
},
|
|
21
|
+
messageId: "missingTemplateYamlPair",
|
|
22
|
+
node: node,
|
|
23
|
+
});
|
|
24
|
+
},
|
|
25
|
+
};
|
|
26
|
+
},
|
|
27
|
+
meta: {
|
|
28
|
+
docs: {
|
|
29
|
+
configs: [
|
|
30
|
+
"github-actions.configs.workflowTemplateProperties",
|
|
31
|
+
"github-actions.configs.workflowTemplates",
|
|
32
|
+
"github-actions.configs.all",
|
|
33
|
+
],
|
|
34
|
+
description: "require each workflow-template `.properties.json` file to have a matching template YAML file.",
|
|
35
|
+
recommended: true,
|
|
36
|
+
requiresTypeChecking: false,
|
|
37
|
+
ruleId: "R055",
|
|
38
|
+
ruleNumber: 55,
|
|
39
|
+
url: "https://nick2bad4u.github.io/eslint-plugin-github-actions-2/docs/rules/require-workflow-template-properties-pair",
|
|
40
|
+
},
|
|
41
|
+
messages: {
|
|
42
|
+
missingTemplateYamlPair: "Workflow template metadata is missing its paired YAML file. Expected '{{pairedYmlPath}}' or '{{pairedYamlPath}}'.",
|
|
43
|
+
},
|
|
44
|
+
schema: [],
|
|
45
|
+
type: "problem",
|
|
46
|
+
},
|
|
47
|
+
};
|
|
48
|
+
export default rule;
|
|
49
|
+
//# sourceMappingURL=require-workflow-template-properties-pair.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"require-workflow-template-properties-pair.js","sourceRoot":"","sources":["../../src/rules/require-workflow-template-properties-pair.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,UAAU,EAAE,MAAM,SAAS,CAAC;AAErC,OAAO,EAAE,gCAAgC,EAAE,MAAM,8BAA8B,CAAC;AAChF,OAAO,EAAE,0BAA0B,EAAE,MAAM,8CAA8C,CAAC;AAE1F,6DAA6D;AAC7D,MAAM,IAAI,GAAoB;IAC1B,MAAM,CAAC,OAAO;QACV,OAAO;YACH,OAAO,CAAC,IAAI;gBACR,IAAI,CAAC,gCAAgC,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC;oBACtD,OAAO;gBACX,CAAC;gBAED,MAAM,CAAC,aAAa,EAAE,cAAc,CAAC,GACjC,0BAA0B,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;gBAEjD,IAAI,UAAU,CAAC,aAAa,CAAC,IAAI,UAAU,CAAC,cAAc,CAAC,EAAE,CAAC;oBAC1D,OAAO;gBACX,CAAC;gBAED,OAAO,CAAC,MAAM,CAAC;oBACX,IAAI,EAAE;wBACF,cAAc;wBACd,aAAa;qBAChB;oBACD,SAAS,EAAE,yBAAyB;oBACpC,IAAI,EAAE,IAA4B;iBACrC,CAAC,CAAC;YACP,CAAC;SACJ,CAAC;IACN,CAAC;IACD,IAAI,EAAE;QACF,IAAI,EAAE;YACF,OAAO,EAAE;gBACL,mDAAmD;gBACnD,0CAA0C;gBAC1C,4BAA4B;aAC/B;YACD,WAAW,EACP,+FAA+F;YACnG,WAAW,EAAE,IAAI;YACjB,oBAAoB,EAAE,KAAK;YAC3B,MAAM,EAAE,MAAM;YACd,UAAU,EAAE,EAAE;YACd,GAAG,EAAE,kHAAkH;SAC1H;QACD,QAAQ,EAAE;YACN,uBAAuB,EACnB,mHAAmH;SAC1H;QACD,MAAM,EAAE,EAAE;QACV,IAAI,EAAE,SAAS;KACG;CACzB,CAAC;AAEF,eAAe,IAAI,CAAC"}
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @packageDocumentation
|
|
3
|
+
* Validate literal job and step timeout-minutes values.
|
|
4
|
+
*/
|
|
5
|
+
import type { Rule } from "eslint";
|
|
6
|
+
/** Rule implementation for validating timeout-minutes ranges. */
|
|
7
|
+
declare const rule: Rule.RuleModule;
|
|
8
|
+
export default rule;
|
|
9
|
+
//# sourceMappingURL=valid-timeout-minutes.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"valid-timeout-minutes.d.ts","sourceRoot":"","sources":["../../src/rules/valid-timeout-minutes.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AA4EnC,iEAAiE;AACjE,QAAA,MAAM,IAAI,EAAE,IAAI,CAAC,UAoShB,CAAC;AAEF,eAAe,IAAI,CAAC"}
|
|
@@ -0,0 +1,255 @@
|
|
|
1
|
+
import { getMappingPair, getMappingValueAsMapping, getMappingValueAsSequence, getScalarNumberValue, getWorkflowRoot, isGithubExpressionScalar, unwrapYamlValue, } from "../_internal/workflow-yaml.js";
|
|
2
|
+
/** Default lower bound for literal timeout-minutes values. */
|
|
3
|
+
const MIN_TIMEOUT_MINUTES = 1;
|
|
4
|
+
/** Default upper bound for literal timeout-minutes values. */
|
|
5
|
+
const MAX_TIMEOUT_MINUTES = 24 * 60;
|
|
6
|
+
/** Default recommended upper bound when only a single number is configured. */
|
|
7
|
+
const DEFAULT_MAX_TIMEOUT_MINUTES = 6 * 60;
|
|
8
|
+
/** Normalize timeout range input into concrete min/max bounds. */
|
|
9
|
+
const normalizeTimeoutRange = (value, fallback) => {
|
|
10
|
+
if (typeof value === "number") {
|
|
11
|
+
return {
|
|
12
|
+
max: value,
|
|
13
|
+
min: fallback.min,
|
|
14
|
+
};
|
|
15
|
+
}
|
|
16
|
+
if (value === undefined) {
|
|
17
|
+
return {
|
|
18
|
+
max: fallback.max,
|
|
19
|
+
min: fallback.min,
|
|
20
|
+
};
|
|
21
|
+
}
|
|
22
|
+
return {
|
|
23
|
+
max: value.max ?? fallback.max,
|
|
24
|
+
min: value.min ?? fallback.min,
|
|
25
|
+
};
|
|
26
|
+
};
|
|
27
|
+
/** Determine whether an options value represents a shared timeout range. */
|
|
28
|
+
const isTimeoutRange = (value) => typeof value === "object" &&
|
|
29
|
+
value !== null &&
|
|
30
|
+
("min" in value || "max" in value);
|
|
31
|
+
/** Determine whether an options value represents split job/step timeout config. */
|
|
32
|
+
const isTimeoutScopeOptions = (value) => typeof value === "object" &&
|
|
33
|
+
value !== null &&
|
|
34
|
+
("job" in value || "step" in value);
|
|
35
|
+
/** Rule implementation for validating timeout-minutes ranges. */
|
|
36
|
+
const rule = {
|
|
37
|
+
create(context) {
|
|
38
|
+
const [options] = context.options;
|
|
39
|
+
const defaultRange = {
|
|
40
|
+
max: DEFAULT_MAX_TIMEOUT_MINUTES,
|
|
41
|
+
min: MIN_TIMEOUT_MINUTES,
|
|
42
|
+
};
|
|
43
|
+
const workflowMaximumRange = {
|
|
44
|
+
max: MAX_TIMEOUT_MINUTES,
|
|
45
|
+
};
|
|
46
|
+
const jobRange = normalizeTimeoutRange(typeof options === "number" || isTimeoutRange(options)
|
|
47
|
+
? options
|
|
48
|
+
: options?.job, defaultRange);
|
|
49
|
+
const stepRange = normalizeTimeoutRange(typeof options === "number" || isTimeoutRange(options)
|
|
50
|
+
? options
|
|
51
|
+
: options?.step, defaultRange);
|
|
52
|
+
if (isTimeoutScopeOptions(options)) {
|
|
53
|
+
jobRange.max = normalizeTimeoutRange(options.job, defaultRange).max;
|
|
54
|
+
jobRange.min = normalizeTimeoutRange(options.job, defaultRange).min;
|
|
55
|
+
stepRange.max = normalizeTimeoutRange(options.step, defaultRange).max;
|
|
56
|
+
stepRange.min = normalizeTimeoutRange(options.step, defaultRange).min;
|
|
57
|
+
}
|
|
58
|
+
const validateTimeoutPair = (timeoutPair, range) => {
|
|
59
|
+
if (isGithubExpressionScalar(timeoutPair.value)) {
|
|
60
|
+
return null;
|
|
61
|
+
}
|
|
62
|
+
const timeoutValue = getScalarNumberValue(timeoutPair.value);
|
|
63
|
+
if (timeoutValue === null ||
|
|
64
|
+
!Number.isInteger(timeoutValue) ||
|
|
65
|
+
timeoutValue <= 0) {
|
|
66
|
+
return "notInteger";
|
|
67
|
+
}
|
|
68
|
+
if (timeoutValue < range.min ||
|
|
69
|
+
timeoutValue > range.max ||
|
|
70
|
+
timeoutValue > workflowMaximumRange.max) {
|
|
71
|
+
return "invalidRange";
|
|
72
|
+
}
|
|
73
|
+
return null;
|
|
74
|
+
};
|
|
75
|
+
return {
|
|
76
|
+
Program() {
|
|
77
|
+
const root = getWorkflowRoot(context);
|
|
78
|
+
if (root === null) {
|
|
79
|
+
return;
|
|
80
|
+
}
|
|
81
|
+
const jobsMapping = getMappingValueAsMapping(root, "jobs");
|
|
82
|
+
if (jobsMapping === null) {
|
|
83
|
+
return;
|
|
84
|
+
}
|
|
85
|
+
for (const jobPair of jobsMapping.pairs) {
|
|
86
|
+
const jobValue = unwrapYamlValue(jobPair.value);
|
|
87
|
+
if (jobValue?.type !== "YAMLMapping") {
|
|
88
|
+
continue;
|
|
89
|
+
}
|
|
90
|
+
const jobTimeoutPair = getMappingPair(jobValue, "timeout-minutes");
|
|
91
|
+
if (jobTimeoutPair !== null) {
|
|
92
|
+
const validationResult = validateTimeoutPair(jobTimeoutPair, jobRange);
|
|
93
|
+
if (validationResult !== null) {
|
|
94
|
+
context.report({
|
|
95
|
+
data: {
|
|
96
|
+
max: String(jobRange.max),
|
|
97
|
+
min: String(jobRange.min),
|
|
98
|
+
},
|
|
99
|
+
messageId: validationResult,
|
|
100
|
+
node: (jobTimeoutPair.value ??
|
|
101
|
+
jobTimeoutPair),
|
|
102
|
+
});
|
|
103
|
+
}
|
|
104
|
+
}
|
|
105
|
+
const stepsSequence = getMappingValueAsSequence(jobValue, "steps");
|
|
106
|
+
if (stepsSequence === null) {
|
|
107
|
+
continue;
|
|
108
|
+
}
|
|
109
|
+
for (const stepEntry of stepsSequence.entries) {
|
|
110
|
+
const stepValue = unwrapYamlValue(stepEntry);
|
|
111
|
+
if (stepValue?.type !== "YAMLMapping") {
|
|
112
|
+
continue;
|
|
113
|
+
}
|
|
114
|
+
const stepTimeoutPair = getMappingPair(stepValue, "timeout-minutes");
|
|
115
|
+
if (stepTimeoutPair === null) {
|
|
116
|
+
continue;
|
|
117
|
+
}
|
|
118
|
+
const validationResult = validateTimeoutPair(stepTimeoutPair, stepRange);
|
|
119
|
+
if (validationResult !== null) {
|
|
120
|
+
context.report({
|
|
121
|
+
data: {
|
|
122
|
+
max: String(stepRange.max),
|
|
123
|
+
min: String(stepRange.min),
|
|
124
|
+
},
|
|
125
|
+
messageId: validationResult,
|
|
126
|
+
node: (stepTimeoutPair.value ??
|
|
127
|
+
stepTimeoutPair),
|
|
128
|
+
});
|
|
129
|
+
}
|
|
130
|
+
}
|
|
131
|
+
}
|
|
132
|
+
},
|
|
133
|
+
};
|
|
134
|
+
},
|
|
135
|
+
meta: {
|
|
136
|
+
defaultOptions: [DEFAULT_MAX_TIMEOUT_MINUTES],
|
|
137
|
+
docs: {
|
|
138
|
+
configs: [
|
|
139
|
+
"github-actions.configs.all",
|
|
140
|
+
"github-actions.configs.recommended",
|
|
141
|
+
"github-actions.configs.strict",
|
|
142
|
+
],
|
|
143
|
+
description: "disallow invalid literal `timeout-minutes` values for jobs and steps.",
|
|
144
|
+
recommended: true,
|
|
145
|
+
requiresTypeChecking: false,
|
|
146
|
+
ruleId: "R017",
|
|
147
|
+
ruleNumber: 17,
|
|
148
|
+
url: "https://nick2bad4u.github.io/eslint-plugin-github-actions-2/docs/rules/valid-timeout-minutes",
|
|
149
|
+
},
|
|
150
|
+
messages: {
|
|
151
|
+
invalidRange: "`timeout-minutes` must stay within the configured range of {{min}}-{{max}}.",
|
|
152
|
+
notInteger: "`timeout-minutes` must be a positive integer or a GitHub expression.",
|
|
153
|
+
},
|
|
154
|
+
schema: [
|
|
155
|
+
{
|
|
156
|
+
anyOf: [
|
|
157
|
+
{
|
|
158
|
+
description: "Maximum allowed timeout-minutes value for both jobs and steps.",
|
|
159
|
+
maximum: MAX_TIMEOUT_MINUTES,
|
|
160
|
+
minimum: MIN_TIMEOUT_MINUTES,
|
|
161
|
+
type: "integer",
|
|
162
|
+
},
|
|
163
|
+
{
|
|
164
|
+
additionalProperties: false,
|
|
165
|
+
description: "Shared min/max range for literal job and step timeout-minutes values.",
|
|
166
|
+
properties: {
|
|
167
|
+
max: {
|
|
168
|
+
description: "Maximum allowed timeout-minutes value.",
|
|
169
|
+
maximum: MAX_TIMEOUT_MINUTES,
|
|
170
|
+
minimum: MIN_TIMEOUT_MINUTES,
|
|
171
|
+
type: "integer",
|
|
172
|
+
},
|
|
173
|
+
min: {
|
|
174
|
+
description: "Minimum allowed timeout-minutes value.",
|
|
175
|
+
maximum: MAX_TIMEOUT_MINUTES,
|
|
176
|
+
minimum: MIN_TIMEOUT_MINUTES,
|
|
177
|
+
type: "integer",
|
|
178
|
+
},
|
|
179
|
+
},
|
|
180
|
+
type: "object",
|
|
181
|
+
},
|
|
182
|
+
{
|
|
183
|
+
additionalProperties: false,
|
|
184
|
+
description: "Separate timeout-minutes limits for jobs and steps.",
|
|
185
|
+
properties: {
|
|
186
|
+
job: {
|
|
187
|
+
anyOf: [
|
|
188
|
+
{
|
|
189
|
+
description: "Maximum allowed timeout-minutes value for jobs.",
|
|
190
|
+
maximum: MAX_TIMEOUT_MINUTES,
|
|
191
|
+
minimum: MIN_TIMEOUT_MINUTES,
|
|
192
|
+
type: "integer",
|
|
193
|
+
},
|
|
194
|
+
{
|
|
195
|
+
additionalProperties: false,
|
|
196
|
+
description: "Min/max range for literal job timeout-minutes values.",
|
|
197
|
+
properties: {
|
|
198
|
+
max: {
|
|
199
|
+
description: "Maximum allowed job timeout-minutes value.",
|
|
200
|
+
maximum: MAX_TIMEOUT_MINUTES,
|
|
201
|
+
minimum: MIN_TIMEOUT_MINUTES,
|
|
202
|
+
type: "integer",
|
|
203
|
+
},
|
|
204
|
+
min: {
|
|
205
|
+
description: "Minimum allowed job timeout-minutes value.",
|
|
206
|
+
maximum: MAX_TIMEOUT_MINUTES,
|
|
207
|
+
minimum: MIN_TIMEOUT_MINUTES,
|
|
208
|
+
type: "integer",
|
|
209
|
+
},
|
|
210
|
+
},
|
|
211
|
+
type: "object",
|
|
212
|
+
},
|
|
213
|
+
],
|
|
214
|
+
},
|
|
215
|
+
step: {
|
|
216
|
+
anyOf: [
|
|
217
|
+
{
|
|
218
|
+
description: "Maximum allowed timeout-minutes value for steps.",
|
|
219
|
+
maximum: MAX_TIMEOUT_MINUTES,
|
|
220
|
+
minimum: MIN_TIMEOUT_MINUTES,
|
|
221
|
+
type: "integer",
|
|
222
|
+
},
|
|
223
|
+
{
|
|
224
|
+
additionalProperties: false,
|
|
225
|
+
description: "Min/max range for literal step timeout-minutes values.",
|
|
226
|
+
properties: {
|
|
227
|
+
max: {
|
|
228
|
+
description: "Maximum allowed step timeout-minutes value.",
|
|
229
|
+
maximum: MAX_TIMEOUT_MINUTES,
|
|
230
|
+
minimum: MIN_TIMEOUT_MINUTES,
|
|
231
|
+
type: "integer",
|
|
232
|
+
},
|
|
233
|
+
min: {
|
|
234
|
+
description: "Minimum allowed step timeout-minutes value.",
|
|
235
|
+
maximum: MAX_TIMEOUT_MINUTES,
|
|
236
|
+
minimum: MIN_TIMEOUT_MINUTES,
|
|
237
|
+
type: "integer",
|
|
238
|
+
},
|
|
239
|
+
},
|
|
240
|
+
type: "object",
|
|
241
|
+
},
|
|
242
|
+
],
|
|
243
|
+
},
|
|
244
|
+
},
|
|
245
|
+
type: "object",
|
|
246
|
+
},
|
|
247
|
+
],
|
|
248
|
+
description: "Configure literal timeout-minutes validation for jobs and steps.",
|
|
249
|
+
},
|
|
250
|
+
],
|
|
251
|
+
type: "suggestion",
|
|
252
|
+
},
|
|
253
|
+
};
|
|
254
|
+
export default rule;
|
|
255
|
+
//# sourceMappingURL=valid-timeout-minutes.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"valid-timeout-minutes.js","sourceRoot":"","sources":["../../src/rules/valid-timeout-minutes.ts"],"names":[],"mappings":"AAOA,OAAO,EACH,cAAc,EACd,wBAAwB,EACxB,yBAAyB,EACzB,oBAAoB,EACpB,eAAe,EACf,wBAAwB,EACxB,eAAe,GAClB,MAAM,+BAA+B,CAAC;AAmBvC,8DAA8D;AAC9D,MAAM,mBAAmB,GAAG,CAAC,CAAC;AAE9B,8DAA8D;AAC9D,MAAM,mBAAmB,GAAG,EAAE,GAAG,EAAE,CAAC;AAEpC,+EAA+E;AAC/E,MAAM,2BAA2B,GAAG,CAAC,GAAG,EAAE,CAAC;AAE3C,kEAAkE;AAClE,MAAM,qBAAqB,GAAG,CAC1B,KAAkD,EAClD,QAAgD,EACpB,EAAE;IAC9B,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QAC5B,OAAO;YACH,GAAG,EAAE,KAAK;YACV,GAAG,EAAE,QAAQ,CAAC,GAAG;SACpB,CAAC;IACN,CAAC;IAED,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;QACtB,OAAO;YACH,GAAG,EAAE,QAAQ,CAAC,GAAG;YACjB,GAAG,EAAE,QAAQ,CAAC,GAAG;SACpB,CAAC;IACN,CAAC;IAED,OAAO;QACH,GAAG,EAAE,KAAK,CAAC,GAAG,IAAI,QAAQ,CAAC,GAAG;QAC9B,GAAG,EAAE,KAAK,CAAC,GAAG,IAAI,QAAQ,CAAC,GAAG;KACjC,CAAC;AACN,CAAC,CAAC;AAEF,4EAA4E;AAC5E,MAAM,cAAc,GAAG,CAAC,KAAc,EAAyB,EAAE,CAC7D,OAAO,KAAK,KAAK,QAAQ;IACzB,KAAK,KAAK,IAAI;IACd,CAAC,KAAK,IAAI,KAAK,IAAI,KAAK,IAAI,KAAK,CAAC,CAAC;AAEvC,mFAAmF;AACnF,MAAM,qBAAqB,GAAG,CAAC,KAAc,EAAgC,EAAE,CAC3E,OAAO,KAAK,KAAK,QAAQ;IACzB,KAAK,KAAK,IAAI;IACd,CAAC,KAAK,IAAI,KAAK,IAAI,MAAM,IAAI,KAAK,CAAC,CAAC;AAExC,iEAAiE;AACjE,MAAM,IAAI,GAAoB;IAC1B,MAAM,CAAC,OAAO;QACV,MAAM,CAAC,OAAO,CAAC,GAAG,OAAO,CAAC,OAAqC,CAAC;QAChE,MAAM,YAAY,GAAG;YACjB,GAAG,EAAE,2BAA2B;YAChC,GAAG,EAAE,mBAAmB;SAC3B,CAAC;QACF,MAAM,oBAAoB,GAAG;YACzB,GAAG,EAAE,mBAAmB;SAC3B,CAAC;QAEF,MAAM,QAAQ,GAAG,qBAAqB,CAClC,OAAO,OAAO,KAAK,QAAQ,IAAI,cAAc,CAAC,OAAO,CAAC;YAClD,CAAC,CAAC,OAAO;YACT,CAAC,CAAC,OAAO,EAAE,GAAG,EAClB,YAAY,CACf,CAAC;QACF,MAAM,SAAS,GAAG,qBAAqB,CACnC,OAAO,OAAO,KAAK,QAAQ,IAAI,cAAc,CAAC,OAAO,CAAC;YAClD,CAAC,CAAC,OAAO;YACT,CAAC,CAAC,OAAO,EAAE,IAAI,EACnB,YAAY,CACf,CAAC;QAEF,IAAI,qBAAqB,CAAC,OAAO,CAAC,EAAE,CAAC;YACjC,QAAQ,CAAC,GAAG,GAAG,qBAAqB,CAAC,OAAO,CAAC,GAAG,EAAE,YAAY,CAAC,CAAC,GAAG,CAAC;YACpE,QAAQ,CAAC,GAAG,GAAG,qBAAqB,CAAC,OAAO,CAAC,GAAG,EAAE,YAAY,CAAC,CAAC,GAAG,CAAC;YACpE,SAAS,CAAC,GAAG,GAAG,qBAAqB,CACjC,OAAO,CAAC,IAAI,EACZ,YAAY,CACf,CAAC,GAAG,CAAC;YACN,SAAS,CAAC,GAAG,GAAG,qBAAqB,CACjC,OAAO,CAAC,IAAI,EACZ,YAAY,CACf,CAAC,GAAG,CAAC;QACV,CAAC;QAED,MAAM,mBAAmB,GAAG,CACxB,WAAmC,EACnC,KAA6C,EACT,EAAE;YACtC,IAAI,wBAAwB,CAAC,WAAW,CAAC,KAAK,CAAC,EAAE,CAAC;gBAC9C,OAAO,IAAI,CAAC;YAChB,CAAC;YAED,MAAM,YAAY,GAAG,oBAAoB,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;YAE7D,IACI,YAAY,KAAK,IAAI;gBACrB,CAAC,MAAM,CAAC,SAAS,CAAC,YAAY,CAAC;gBAC/B,YAAY,IAAI,CAAC,EACnB,CAAC;gBACC,OAAO,YAAY,CAAC;YACxB,CAAC;YAED,IACI,YAAY,GAAG,KAAK,CAAC,GAAG;gBACxB,YAAY,GAAG,KAAK,CAAC,GAAG;gBACxB,YAAY,GAAG,oBAAoB,CAAC,GAAG,EACzC,CAAC;gBACC,OAAO,cAAc,CAAC;YAC1B,CAAC;YAED,OAAO,IAAI,CAAC;QAChB,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,WAAW,GAAG,wBAAwB,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;gBAE3D,IAAI,WAAW,KAAK,IAAI,EAAE,CAAC;oBACvB,OAAO;gBACX,CAAC;gBAED,KAAK,MAAM,OAAO,IAAI,WAAW,CAAC,KAAK,EAAE,CAAC;oBACtC,MAAM,QAAQ,GAAG,eAAe,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;oBAEhD,IAAI,QAAQ,EAAE,IAAI,KAAK,aAAa,EAAE,CAAC;wBACnC,SAAS;oBACb,CAAC;oBAED,MAAM,cAAc,GAAG,cAAc,CACjC,QAAQ,EACR,iBAAiB,CACpB,CAAC;oBAEF,IAAI,cAAc,KAAK,IAAI,EAAE,CAAC;wBAC1B,MAAM,gBAAgB,GAAG,mBAAmB,CACxC,cAAc,EACd,QAAQ,CACX,CAAC;wBAEF,IAAI,gBAAgB,KAAK,IAAI,EAAE,CAAC;4BAC5B,OAAO,CAAC,MAAM,CAAC;gCACX,IAAI,EAAE;oCACF,GAAG,EAAE,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC;oCACzB,GAAG,EAAE,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC;iCAC5B;gCACD,SAAS,EAAE,gBAAgB;gCAC3B,IAAI,EAAE,CAAC,cAAc,CAAC,KAAK;oCACvB,cAAc,CAAyB;6BAC9C,CAAC,CAAC;wBACP,CAAC;oBACL,CAAC;oBAED,MAAM,aAAa,GAAG,yBAAyB,CAC3C,QAAQ,EACR,OAAO,CACV,CAAC;oBAEF,IAAI,aAAa,KAAK,IAAI,EAAE,CAAC;wBACzB,SAAS;oBACb,CAAC;oBAED,KAAK,MAAM,SAAS,IAAI,aAAa,CAAC,OAAO,EAAE,CAAC;wBAC5C,MAAM,SAAS,GAAG,eAAe,CAAC,SAAS,CAAC,CAAC;wBAE7C,IAAI,SAAS,EAAE,IAAI,KAAK,aAAa,EAAE,CAAC;4BACpC,SAAS;wBACb,CAAC;wBAED,MAAM,eAAe,GAAG,cAAc,CAClC,SAAS,EACT,iBAAiB,CACpB,CAAC;wBAEF,IAAI,eAAe,KAAK,IAAI,EAAE,CAAC;4BAC3B,SAAS;wBACb,CAAC;wBAED,MAAM,gBAAgB,GAAG,mBAAmB,CACxC,eAAe,EACf,SAAS,CACZ,CAAC;wBAEF,IAAI,gBAAgB,KAAK,IAAI,EAAE,CAAC;4BAC5B,OAAO,CAAC,MAAM,CAAC;gCACX,IAAI,EAAE;oCACF,GAAG,EAAE,MAAM,CAAC,SAAS,CAAC,GAAG,CAAC;oCAC1B,GAAG,EAAE,MAAM,CAAC,SAAS,CAAC,GAAG,CAAC;iCAC7B;gCACD,SAAS,EAAE,gBAAgB;gCAC3B,IAAI,EAAE,CAAC,eAAe,CAAC,KAAK;oCACxB,eAAe,CAAyB;6BAC/C,CAAC,CAAC;wBACP,CAAC;oBACL,CAAC;gBACL,CAAC;YACL,CAAC;SACJ,CAAC;IACN,CAAC;IACD,IAAI,EAAE;QACF,cAAc,EAAE,CAAC,2BAA2B,CAAC;QAC7C,IAAI,EAAE;YACF,OAAO,EAAE;gBACL,4BAA4B;gBAC5B,oCAAoC;gBACpC,+BAA+B;aAClC;YACD,WAAW,EACP,uEAAuE;YAC3E,WAAW,EAAE,IAAI;YACjB,oBAAoB,EAAE,KAAK;YAC3B,MAAM,EAAE,MAAM;YACd,UAAU,EAAE,EAAE;YACd,GAAG,EAAE,8FAA8F;SACtG;QACD,QAAQ,EAAE;YACN,YAAY,EACR,6EAA6E;YACjF,UAAU,EACN,sEAAsE;SAC7E;QACD,MAAM,EAAE;YACJ;gBACI,KAAK,EAAE;oBACH;wBACI,WAAW,EACP,gEAAgE;wBACpE,OAAO,EAAE,mBAAmB;wBAC5B,OAAO,EAAE,mBAAmB;wBAC5B,IAAI,EAAE,SAAS;qBAClB;oBACD;wBACI,oBAAoB,EAAE,KAAK;wBAC3B,WAAW,EACP,uEAAuE;wBAC3E,UAAU,EAAE;4BACR,GAAG,EAAE;gCACD,WAAW,EACP,wCAAwC;gCAC5C,OAAO,EAAE,mBAAmB;gCAC5B,OAAO,EAAE,mBAAmB;gCAC5B,IAAI,EAAE,SAAS;6BAClB;4BACD,GAAG,EAAE;gCACD,WAAW,EACP,wCAAwC;gCAC5C,OAAO,EAAE,mBAAmB;gCAC5B,OAAO,EAAE,mBAAmB;gCAC5B,IAAI,EAAE,SAAS;6BAClB;yBACJ;wBACD,IAAI,EAAE,QAAQ;qBACjB;oBACD;wBACI,oBAAoB,EAAE,KAAK;wBAC3B,WAAW,EACP,qDAAqD;wBACzD,UAAU,EAAE;4BACR,GAAG,EAAE;gCACD,KAAK,EAAE;oCACH;wCACI,WAAW,EACP,iDAAiD;wCACrD,OAAO,EAAE,mBAAmB;wCAC5B,OAAO,EAAE,mBAAmB;wCAC5B,IAAI,EAAE,SAAS;qCAClB;oCACD;wCACI,oBAAoB,EAAE,KAAK;wCAC3B,WAAW,EACP,uDAAuD;wCAC3D,UAAU,EAAE;4CACR,GAAG,EAAE;gDACD,WAAW,EACP,4CAA4C;gDAChD,OAAO,EAAE,mBAAmB;gDAC5B,OAAO,EAAE,mBAAmB;gDAC5B,IAAI,EAAE,SAAS;6CAClB;4CACD,GAAG,EAAE;gDACD,WAAW,EACP,4CAA4C;gDAChD,OAAO,EAAE,mBAAmB;gDAC5B,OAAO,EAAE,mBAAmB;gDAC5B,IAAI,EAAE,SAAS;6CAClB;yCACJ;wCACD,IAAI,EAAE,QAAQ;qCACjB;iCACJ;6BACJ;4BACD,IAAI,EAAE;gCACF,KAAK,EAAE;oCACH;wCACI,WAAW,EACP,kDAAkD;wCACtD,OAAO,EAAE,mBAAmB;wCAC5B,OAAO,EAAE,mBAAmB;wCAC5B,IAAI,EAAE,SAAS;qCAClB;oCACD;wCACI,oBAAoB,EAAE,KAAK;wCAC3B,WAAW,EACP,wDAAwD;wCAC5D,UAAU,EAAE;4CACR,GAAG,EAAE;gDACD,WAAW,EACP,6CAA6C;gDACjD,OAAO,EAAE,mBAAmB;gDAC5B,OAAO,EAAE,mBAAmB;gDAC5B,IAAI,EAAE,SAAS;6CAClB;4CACD,GAAG,EAAE;gDACD,WAAW,EACP,6CAA6C;gDACjD,OAAO,EAAE,mBAAmB;gDAC5B,OAAO,EAAE,mBAAmB;gDAC5B,IAAI,EAAE,SAAS;6CAClB;yCACJ;wCACD,IAAI,EAAE,QAAQ;qCACjB;iCACJ;6BACJ;yBACJ;wBACD,IAAI,EAAE,QAAQ;qBACjB;iBACJ;gBACD,WAAW,EACP,kEAAkE;aACzE;SACJ;QACD,IAAI,EAAE,YAAY;KACA;CACzB,CAAC;AAEF,eAAe,IAAI,CAAC"}
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @packageDocumentation
|
|
3
|
+
* Validate GitHub Actions workflow trigger event names.
|
|
4
|
+
*/
|
|
5
|
+
import type { Rule } from "eslint";
|
|
6
|
+
/** Rule implementation for validating `on:` trigger event names. */
|
|
7
|
+
declare const rule: Rule.RuleModule;
|
|
8
|
+
export default rule;
|
|
9
|
+
//# sourceMappingURL=valid-trigger-events.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"valid-trigger-events.d.ts","sourceRoot":"","sources":["../../src/rules/valid-trigger-events.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAWnC,oEAAoE;AACpE,QAAA,MAAM,IAAI,EAAE,IAAI,CAAC,UAyHhB,CAAC;AAEF,eAAe,IAAI,CAAC"}
|
|
@@ -0,0 +1,100 @@
|
|
|
1
|
+
import { githubActionsTriggerEventSet } from "../_internal/github-actions-trigger-events.js";
|
|
2
|
+
import { getMappingPair, getScalarStringValue, getWorkflowRoot, unwrapYamlValue, } from "../_internal/workflow-yaml.js";
|
|
3
|
+
/** Rule implementation for validating `on:` trigger event names. */
|
|
4
|
+
const rule = {
|
|
5
|
+
create(context) {
|
|
6
|
+
const reportInvalidEvent = (node, eventName) => {
|
|
7
|
+
context.report({
|
|
8
|
+
data: {
|
|
9
|
+
event: eventName,
|
|
10
|
+
},
|
|
11
|
+
messageId: "invalidEvent",
|
|
12
|
+
node: node,
|
|
13
|
+
});
|
|
14
|
+
};
|
|
15
|
+
return {
|
|
16
|
+
Program() {
|
|
17
|
+
const root = getWorkflowRoot(context);
|
|
18
|
+
if (root === null) {
|
|
19
|
+
return;
|
|
20
|
+
}
|
|
21
|
+
const onPair = getMappingPair(root, "on");
|
|
22
|
+
const onValue = unwrapYamlValue(onPair?.value ?? null);
|
|
23
|
+
if (onValue === null) {
|
|
24
|
+
return;
|
|
25
|
+
}
|
|
26
|
+
if (onValue.type === "YAMLScalar") {
|
|
27
|
+
const eventName = getScalarStringValue(onValue);
|
|
28
|
+
if (eventName !== null &&
|
|
29
|
+
!githubActionsTriggerEventSet.has(eventName)) {
|
|
30
|
+
reportInvalidEvent(onValue, eventName);
|
|
31
|
+
}
|
|
32
|
+
return;
|
|
33
|
+
}
|
|
34
|
+
if (onValue.type === "YAMLSequence") {
|
|
35
|
+
for (const entry of onValue.entries) {
|
|
36
|
+
const unwrappedEntry = unwrapYamlValue(entry);
|
|
37
|
+
const eventName = getScalarStringValue(unwrappedEntry);
|
|
38
|
+
if (unwrappedEntry !== null &&
|
|
39
|
+
(eventName === null ||
|
|
40
|
+
!githubActionsTriggerEventSet.has(eventName))) {
|
|
41
|
+
context.report({
|
|
42
|
+
data: {
|
|
43
|
+
event: eventName ?? "<unknown>",
|
|
44
|
+
},
|
|
45
|
+
messageId: eventName === null
|
|
46
|
+
? "invalidEventEntry"
|
|
47
|
+
: "invalidEvent",
|
|
48
|
+
node: unwrappedEntry,
|
|
49
|
+
});
|
|
50
|
+
}
|
|
51
|
+
}
|
|
52
|
+
return;
|
|
53
|
+
}
|
|
54
|
+
if (onValue.type !== "YAMLMapping") {
|
|
55
|
+
context.report({
|
|
56
|
+
messageId: "invalidEventEntry",
|
|
57
|
+
node: onValue,
|
|
58
|
+
});
|
|
59
|
+
return;
|
|
60
|
+
}
|
|
61
|
+
for (const pair of onValue.pairs) {
|
|
62
|
+
const eventName = getScalarStringValue(pair.key);
|
|
63
|
+
if (eventName === null) {
|
|
64
|
+
context.report({
|
|
65
|
+
messageId: "invalidEventEntry",
|
|
66
|
+
node: pair,
|
|
67
|
+
});
|
|
68
|
+
continue;
|
|
69
|
+
}
|
|
70
|
+
if (!githubActionsTriggerEventSet.has(eventName)) {
|
|
71
|
+
reportInvalidEvent(pair.key, eventName);
|
|
72
|
+
}
|
|
73
|
+
}
|
|
74
|
+
},
|
|
75
|
+
};
|
|
76
|
+
},
|
|
77
|
+
meta: {
|
|
78
|
+
docs: {
|
|
79
|
+
configs: [
|
|
80
|
+
"github-actions.configs.all",
|
|
81
|
+
"github-actions.configs.recommended",
|
|
82
|
+
"github-actions.configs.strict",
|
|
83
|
+
],
|
|
84
|
+
description: "disallow invalid GitHub Actions trigger events under the workflow `on` key.",
|
|
85
|
+
recommended: true,
|
|
86
|
+
requiresTypeChecking: false,
|
|
87
|
+
ruleId: "R018",
|
|
88
|
+
ruleNumber: 18,
|
|
89
|
+
url: "https://nick2bad4u.github.io/eslint-plugin-github-actions-2/docs/rules/valid-trigger-events",
|
|
90
|
+
},
|
|
91
|
+
messages: {
|
|
92
|
+
invalidEvent: "`{{event}}` is not a documented GitHub Actions workflow trigger event.",
|
|
93
|
+
invalidEventEntry: "Workflow `on` entries must use string event names.",
|
|
94
|
+
},
|
|
95
|
+
schema: [],
|
|
96
|
+
type: "problem",
|
|
97
|
+
},
|
|
98
|
+
};
|
|
99
|
+
export default rule;
|
|
100
|
+
//# sourceMappingURL=valid-trigger-events.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"valid-trigger-events.js","sourceRoot":"","sources":["../../src/rules/valid-trigger-events.ts"],"names":[],"mappings":"AAOA,OAAO,EAAE,4BAA4B,EAAE,MAAM,+CAA+C,CAAC;AAC7F,OAAO,EACH,cAAc,EACd,oBAAoB,EACpB,eAAe,EACf,eAAe,GAClB,MAAM,+BAA+B,CAAC;AAEvC,oEAAoE;AACpE,MAAM,IAAI,GAAoB;IAC1B,MAAM,CAAC,OAAO;QACV,MAAM,kBAAkB,GAAG,CACvB,IAA4B,EAC5B,SAAiB,EACb,EAAE;YACN,OAAO,CAAC,MAAM,CAAC;gBACX,IAAI,EAAE;oBACF,KAAK,EAAE,SAAS;iBACnB;gBACD,SAAS,EAAE,cAAc;gBACzB,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,MAAM,SAAS,GAAG,oBAAoB,CAAC,OAAO,CAAC,CAAC;oBAEhD,IACI,SAAS,KAAK,IAAI;wBAClB,CAAC,4BAA4B,CAAC,GAAG,CAAC,SAAS,CAAC,EAC9C,CAAC;wBACC,kBAAkB,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC;oBAC3C,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,MAAM,cAAc,GAAG,eAAe,CAAC,KAAK,CAAC,CAAC;wBAC9C,MAAM,SAAS,GAAG,oBAAoB,CAAC,cAAc,CAAC,CAAC;wBAEvD,IACI,cAAc,KAAK,IAAI;4BACvB,CAAC,SAAS,KAAK,IAAI;gCACf,CAAC,4BAA4B,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,EACnD,CAAC;4BACC,OAAO,CAAC,MAAM,CAAC;gCACX,IAAI,EAAE;oCACF,KAAK,EAAE,SAAS,IAAI,WAAW;iCAClC;gCACD,SAAS,EACL,SAAS,KAAK,IAAI;oCACd,CAAC,CAAC,mBAAmB;oCACrB,CAAC,CAAC,cAAc;gCACxB,IAAI,EAAE,cAAsC;6BAC/C,CAAC,CAAC;wBACP,CAAC;oBACL,CAAC;oBAED,OAAO;gBACX,CAAC;gBAED,IAAI,OAAO,CAAC,IAAI,KAAK,aAAa,EAAE,CAAC;oBACjC,OAAO,CAAC,MAAM,CAAC;wBACX,SAAS,EAAE,mBAAmB;wBAC9B,IAAI,EAAE,OAA+B;qBACxC,CAAC,CAAC;oBAEH,OAAO;gBACX,CAAC;gBAED,KAAK,MAAM,IAAI,IAAI,OAAO,CAAC,KAAK,EAAE,CAAC;oBAC/B,MAAM,SAAS,GAAG,oBAAoB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;oBAEjD,IAAI,SAAS,KAAK,IAAI,EAAE,CAAC;wBACrB,OAAO,CAAC,MAAM,CAAC;4BACX,SAAS,EAAE,mBAAmB;4BAC9B,IAAI,EAAE,IAA4B;yBACrC,CAAC,CAAC;wBAEH,SAAS;oBACb,CAAC;oBAED,IAAI,CAAC,4BAA4B,CAAC,GAAG,CAAC,SAAS,CAAC,EAAE,CAAC;wBAC/C,kBAAkB,CAAC,IAAI,CAAC,GAAmB,EAAE,SAAS,CAAC,CAAC;oBAC5D,CAAC;gBACL,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,6EAA6E;YACjF,WAAW,EAAE,IAAI;YACjB,oBAAoB,EAAE,KAAK;YAC3B,MAAM,EAAE,MAAM;YACd,UAAU,EAAE,EAAE;YACd,GAAG,EAAE,6FAA6F;SACrG;QACD,QAAQ,EAAE;YACN,YAAY,EACR,wEAAwE;YAC5E,iBAAiB,EACb,oDAAoD;SAC3D;QACD,MAAM,EAAE,EAAE;QACV,IAAI,EAAE,SAAS;KACG;CACzB,CAAC;AAEF,eAAe,IAAI,CAAC"}
|