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,79 @@
|
|
|
1
|
+
import { getMappingPair, getMappingValueAsMapping, getScalarStringValue, getWorkflowRoot, unwrapYamlValue, } from "../_internal/workflow-yaml.js";
|
|
2
|
+
/** Rule implementation for requiring explicit reusable-workflow output values. */
|
|
3
|
+
const rule = {
|
|
4
|
+
create(context) {
|
|
5
|
+
return {
|
|
6
|
+
Program() {
|
|
7
|
+
const root = getWorkflowRoot(context);
|
|
8
|
+
if (root === null) {
|
|
9
|
+
return;
|
|
10
|
+
}
|
|
11
|
+
const onMapping = getMappingValueAsMapping(root, "on");
|
|
12
|
+
if (onMapping === null) {
|
|
13
|
+
return;
|
|
14
|
+
}
|
|
15
|
+
const workflowCallMapping = unwrapYamlValue(getMappingPair(onMapping, "workflow_call")?.value ?? null);
|
|
16
|
+
if (workflowCallMapping?.type !== "YAMLMapping") {
|
|
17
|
+
return;
|
|
18
|
+
}
|
|
19
|
+
const outputsMapping = getMappingValueAsMapping(workflowCallMapping, "outputs");
|
|
20
|
+
if (outputsMapping === null) {
|
|
21
|
+
return;
|
|
22
|
+
}
|
|
23
|
+
for (const pair of outputsMapping.pairs) {
|
|
24
|
+
const outputId = getScalarStringValue(pair.key);
|
|
25
|
+
const outputMapping = unwrapYamlValue(pair.value);
|
|
26
|
+
if (outputId === null ||
|
|
27
|
+
outputMapping?.type !== "YAMLMapping") {
|
|
28
|
+
continue;
|
|
29
|
+
}
|
|
30
|
+
const valuePair = getMappingPair(outputMapping, "value");
|
|
31
|
+
if (valuePair === null) {
|
|
32
|
+
context.report({
|
|
33
|
+
data: {
|
|
34
|
+
outputId,
|
|
35
|
+
},
|
|
36
|
+
messageId: "missingValue",
|
|
37
|
+
node: pair.key,
|
|
38
|
+
});
|
|
39
|
+
continue;
|
|
40
|
+
}
|
|
41
|
+
const value = getScalarStringValue(valuePair.value);
|
|
42
|
+
if (value === null || value.trim().length === 0) {
|
|
43
|
+
context.report({
|
|
44
|
+
data: {
|
|
45
|
+
outputId,
|
|
46
|
+
},
|
|
47
|
+
messageId: "invalidValue",
|
|
48
|
+
node: (valuePair.value ??
|
|
49
|
+
valuePair),
|
|
50
|
+
});
|
|
51
|
+
}
|
|
52
|
+
}
|
|
53
|
+
},
|
|
54
|
+
};
|
|
55
|
+
},
|
|
56
|
+
meta: {
|
|
57
|
+
docs: {
|
|
58
|
+
configs: [
|
|
59
|
+
"github-actions.configs.all",
|
|
60
|
+
"github-actions.configs.recommended",
|
|
61
|
+
"github-actions.configs.strict",
|
|
62
|
+
],
|
|
63
|
+
description: "require every `workflow_call` output to declare a non-empty `value` so reusable workflows expose concrete runtime output mappings.",
|
|
64
|
+
recommended: true,
|
|
65
|
+
requiresTypeChecking: false,
|
|
66
|
+
ruleId: "R039",
|
|
67
|
+
ruleNumber: 39,
|
|
68
|
+
url: "https://nick2bad4u.github.io/eslint-plugin-github-actions-2/docs/rules/require-workflow-call-output-value",
|
|
69
|
+
},
|
|
70
|
+
messages: {
|
|
71
|
+
invalidValue: "`workflow_call` output '{{outputId}}' must set `value` to a non-empty scalar expression.",
|
|
72
|
+
missingValue: "`workflow_call` output '{{outputId}}' should declare `value` explicitly.",
|
|
73
|
+
},
|
|
74
|
+
schema: [],
|
|
75
|
+
type: "problem",
|
|
76
|
+
},
|
|
77
|
+
};
|
|
78
|
+
export default rule;
|
|
79
|
+
//# sourceMappingURL=require-workflow-call-output-value.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"require-workflow-call-output-value.js","sourceRoot":"","sources":["../../src/rules/require-workflow-call-output-value.ts"],"names":[],"mappings":"AAMA,OAAO,EACH,cAAc,EACd,wBAAwB,EACxB,oBAAoB,EACpB,eAAe,EACf,eAAe,GAClB,MAAM,+BAA+B,CAAC;AAEvC,kFAAkF;AAClF,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,mBAAmB,GAAG,eAAe,CACvC,cAAc,CAAC,SAAS,EAAE,eAAe,CAAC,EAAE,KAAK,IAAI,IAAI,CAC5D,CAAC;gBAEF,IAAI,mBAAmB,EAAE,IAAI,KAAK,aAAa,EAAE,CAAC;oBAC9C,OAAO;gBACX,CAAC;gBAED,MAAM,cAAc,GAAG,wBAAwB,CAC3C,mBAAmB,EACnB,SAAS,CACZ,CAAC;gBAEF,IAAI,cAAc,KAAK,IAAI,EAAE,CAAC;oBAC1B,OAAO;gBACX,CAAC;gBAED,KAAK,MAAM,IAAI,IAAI,cAAc,CAAC,KAAK,EAAE,CAAC;oBACtC,MAAM,QAAQ,GAAG,oBAAoB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;oBAChD,MAAM,aAAa,GAAG,eAAe,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;oBAElD,IACI,QAAQ,KAAK,IAAI;wBACjB,aAAa,EAAE,IAAI,KAAK,aAAa,EACvC,CAAC;wBACC,SAAS;oBACb,CAAC;oBAED,MAAM,SAAS,GAAG,cAAc,CAAC,aAAa,EAAE,OAAO,CAAC,CAAC;oBAEzD,IAAI,SAAS,KAAK,IAAI,EAAE,CAAC;wBACrB,OAAO,CAAC,MAAM,CAAC;4BACX,IAAI,EAAE;gCACF,QAAQ;6BACX;4BACD,SAAS,EAAE,cAAc;4BACzB,IAAI,EAAE,IAAI,CAAC,GAA2B;yBACzC,CAAC,CAAC;wBAEH,SAAS;oBACb,CAAC;oBAED,MAAM,KAAK,GAAG,oBAAoB,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;oBAEpD,IAAI,KAAK,KAAK,IAAI,IAAI,KAAK,CAAC,IAAI,EAAE,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;wBAC9C,OAAO,CAAC,MAAM,CAAC;4BACX,IAAI,EAAE;gCACF,QAAQ;6BACX;4BACD,SAAS,EAAE,cAAc;4BACzB,IAAI,EAAE,CAAC,SAAS,CAAC,KAAK;gCAClB,SAAS,CAAyB;yBACzC,CAAC,CAAC;oBACP,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,oIAAoI;YACxI,WAAW,EAAE,IAAI;YACjB,oBAAoB,EAAE,KAAK;YAC3B,MAAM,EAAE,MAAM;YACd,UAAU,EAAE,EAAE;YACd,GAAG,EAAE,2GAA2G;SACnH;QACD,QAAQ,EAAE;YACN,YAAY,EACR,0FAA0F;YAC9F,YAAY,EACR,0EAA0E;SACjF;QACD,MAAM,EAAE,EAAE;QACV,IAAI,EAAE,SAAS;KACG;CACzB,CAAC;AAEF,eAAe,IAAI,CAAC"}
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @packageDocumentation
|
|
3
|
+
* Require top-level workflow concurrency controls for relevant workflow triggers.
|
|
4
|
+
*/
|
|
5
|
+
import type { Rule } from "eslint";
|
|
6
|
+
/** Rule implementation for requiring workflow-level concurrency controls. */
|
|
7
|
+
declare const rule: Rule.RuleModule;
|
|
8
|
+
export default rule;
|
|
9
|
+
//# sourceMappingURL=require-workflow-concurrency.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"require-workflow-concurrency.d.ts","sourceRoot":"","sources":["../../src/rules/require-workflow-concurrency.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AA4BnC,6EAA6E;AAC7E,QAAA,MAAM,IAAI,EAAE,IAAI,CAAC,UAkMhB,CAAC;AAEF,eAAe,IAAI,CAAC"}
|
|
@@ -0,0 +1,157 @@
|
|
|
1
|
+
import { getMappingPair, getScalarStringValue, getWorkflowEventNames, getWorkflowRoot, isGithubExpressionScalar, unwrapYamlValue, } from "../_internal/workflow-yaml.js";
|
|
2
|
+
/** Default event set that most benefits from workflow-level concurrency. */
|
|
3
|
+
const DEFAULT_TRIGGER_EVENTS = [
|
|
4
|
+
"merge_group",
|
|
5
|
+
"pull_request",
|
|
6
|
+
"pull_request_target",
|
|
7
|
+
"push",
|
|
8
|
+
"workflow_dispatch",
|
|
9
|
+
];
|
|
10
|
+
/** Rule implementation for requiring workflow-level concurrency controls. */
|
|
11
|
+
const rule = {
|
|
12
|
+
create(context) {
|
|
13
|
+
const [options] = context.options;
|
|
14
|
+
const requiredTriggerEvents = new Set(options?.onlyForEvents ?? DEFAULT_TRIGGER_EVENTS);
|
|
15
|
+
const requireCancelInProgress = options?.requireCancelInProgress ?? true;
|
|
16
|
+
return {
|
|
17
|
+
Program() {
|
|
18
|
+
const root = getWorkflowRoot(context);
|
|
19
|
+
if (root === null) {
|
|
20
|
+
return;
|
|
21
|
+
}
|
|
22
|
+
const eventNames = getWorkflowEventNames(root);
|
|
23
|
+
const shouldRequireConcurrency = [
|
|
24
|
+
...requiredTriggerEvents,
|
|
25
|
+
].some((eventName) => eventNames.has(eventName));
|
|
26
|
+
if (!shouldRequireConcurrency) {
|
|
27
|
+
return;
|
|
28
|
+
}
|
|
29
|
+
const concurrencyPair = getMappingPair(root, "concurrency");
|
|
30
|
+
if (concurrencyPair === null) {
|
|
31
|
+
context.report({
|
|
32
|
+
messageId: "missingConcurrency",
|
|
33
|
+
node: root,
|
|
34
|
+
});
|
|
35
|
+
return;
|
|
36
|
+
}
|
|
37
|
+
const concurrencyValue = unwrapYamlValue(concurrencyPair.value);
|
|
38
|
+
if (concurrencyValue === null) {
|
|
39
|
+
context.report({
|
|
40
|
+
messageId: "invalidConcurrency",
|
|
41
|
+
node: concurrencyPair,
|
|
42
|
+
});
|
|
43
|
+
return;
|
|
44
|
+
}
|
|
45
|
+
if (concurrencyValue.type === "YAMLScalar") {
|
|
46
|
+
const groupValue = getScalarStringValue(concurrencyValue);
|
|
47
|
+
if (groupValue === null || groupValue.trim().length === 0) {
|
|
48
|
+
context.report({
|
|
49
|
+
messageId: "invalidConcurrency",
|
|
50
|
+
node: concurrencyValue,
|
|
51
|
+
});
|
|
52
|
+
}
|
|
53
|
+
return;
|
|
54
|
+
}
|
|
55
|
+
if (concurrencyValue.type !== "YAMLMapping") {
|
|
56
|
+
context.report({
|
|
57
|
+
messageId: "invalidConcurrency",
|
|
58
|
+
node: concurrencyValue,
|
|
59
|
+
});
|
|
60
|
+
return;
|
|
61
|
+
}
|
|
62
|
+
const groupPair = getMappingPair(concurrencyValue, "group");
|
|
63
|
+
const groupValue = getScalarStringValue(groupPair?.value ?? null);
|
|
64
|
+
if (groupPair === null ||
|
|
65
|
+
groupValue === null ||
|
|
66
|
+
groupValue.trim() === "") {
|
|
67
|
+
context.report({
|
|
68
|
+
messageId: "missingGroup",
|
|
69
|
+
node: groupPair?.key ?? concurrencyValue,
|
|
70
|
+
});
|
|
71
|
+
}
|
|
72
|
+
if (!requireCancelInProgress) {
|
|
73
|
+
return;
|
|
74
|
+
}
|
|
75
|
+
const cancelInProgressPair = getMappingPair(concurrencyValue, "cancel-in-progress");
|
|
76
|
+
if (cancelInProgressPair === null) {
|
|
77
|
+
context.report({
|
|
78
|
+
messageId: "missingCancelInProgress",
|
|
79
|
+
node: concurrencyValue,
|
|
80
|
+
});
|
|
81
|
+
return;
|
|
82
|
+
}
|
|
83
|
+
if (isGithubExpressionScalar(cancelInProgressPair.value)) {
|
|
84
|
+
return;
|
|
85
|
+
}
|
|
86
|
+
if (unwrapYamlValue(cancelInProgressPair.value)?.type !==
|
|
87
|
+
"YAMLScalar") {
|
|
88
|
+
context.report({
|
|
89
|
+
messageId: "cancelInProgressDisabled",
|
|
90
|
+
node: cancelInProgressPair.value ?? cancelInProgressPair,
|
|
91
|
+
});
|
|
92
|
+
return;
|
|
93
|
+
}
|
|
94
|
+
if (cancelInProgressPair.value?.type !== "YAMLScalar") {
|
|
95
|
+
context.report({
|
|
96
|
+
messageId: "cancelInProgressDisabled",
|
|
97
|
+
node: cancelInProgressPair.value ?? cancelInProgressPair,
|
|
98
|
+
});
|
|
99
|
+
return;
|
|
100
|
+
}
|
|
101
|
+
if (cancelInProgressPair.value.value !== true) {
|
|
102
|
+
context.report({
|
|
103
|
+
messageId: "cancelInProgressDisabled",
|
|
104
|
+
node: cancelInProgressPair.value,
|
|
105
|
+
});
|
|
106
|
+
}
|
|
107
|
+
},
|
|
108
|
+
};
|
|
109
|
+
},
|
|
110
|
+
meta: {
|
|
111
|
+
defaultOptions: [{}],
|
|
112
|
+
docs: {
|
|
113
|
+
configs: [
|
|
114
|
+
"github-actions.configs.all",
|
|
115
|
+
"github-actions.configs.strict",
|
|
116
|
+
],
|
|
117
|
+
description: "require workflow-level `concurrency` so redundant runs can be deduplicated predictably.",
|
|
118
|
+
recommended: false,
|
|
119
|
+
requiresTypeChecking: false,
|
|
120
|
+
ruleId: "R004",
|
|
121
|
+
ruleNumber: 4,
|
|
122
|
+
url: "https://nick2bad4u.github.io/eslint-plugin-github-actions-2/docs/rules/require-workflow-concurrency",
|
|
123
|
+
},
|
|
124
|
+
messages: {
|
|
125
|
+
cancelInProgressDisabled: "Workflow `concurrency.cancel-in-progress` should be `true` or a GitHub expression so stale runs can be cancelled.",
|
|
126
|
+
invalidConcurrency: "Workflow `concurrency` should be a string/expression or an object containing at least `group`.",
|
|
127
|
+
missingCancelInProgress: "Workflow `concurrency` should set `cancel-in-progress` to cancel superseded runs.",
|
|
128
|
+
missingConcurrency: "Add a top-level `concurrency` block so overlapping workflow runs do not pile up.",
|
|
129
|
+
missingGroup: "Workflow `concurrency` should declare a non-empty `group` value.",
|
|
130
|
+
},
|
|
131
|
+
schema: [
|
|
132
|
+
{
|
|
133
|
+
additionalProperties: false,
|
|
134
|
+
description: "Optional configuration for which events require workflow-level concurrency and whether cancel-in-progress is mandatory.",
|
|
135
|
+
properties: {
|
|
136
|
+
onlyForEvents: {
|
|
137
|
+
description: "Event names that should trigger the workflow-level concurrency requirement.",
|
|
138
|
+
items: {
|
|
139
|
+
minLength: 1,
|
|
140
|
+
type: "string",
|
|
141
|
+
},
|
|
142
|
+
type: "array",
|
|
143
|
+
uniqueItems: true,
|
|
144
|
+
},
|
|
145
|
+
requireCancelInProgress: {
|
|
146
|
+
description: "Require concurrency.cancel-in-progress so newer runs can cancel superseded work.",
|
|
147
|
+
type: "boolean",
|
|
148
|
+
},
|
|
149
|
+
},
|
|
150
|
+
type: "object",
|
|
151
|
+
},
|
|
152
|
+
],
|
|
153
|
+
type: "suggestion",
|
|
154
|
+
},
|
|
155
|
+
};
|
|
156
|
+
export default rule;
|
|
157
|
+
//# sourceMappingURL=require-workflow-concurrency.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"require-workflow-concurrency.js","sourceRoot":"","sources":["../../src/rules/require-workflow-concurrency.ts"],"names":[],"mappings":"AAMA,OAAO,EACH,cAAc,EACd,oBAAoB,EACpB,qBAAqB,EACrB,eAAe,EACf,wBAAwB,EACxB,eAAe,GAClB,MAAM,+BAA+B,CAAC;AAEvC,4EAA4E;AAC5E,MAAM,sBAAsB,GAAG;IAC3B,aAAa;IACb,cAAc;IACd,qBAAqB;IACrB,MAAM;IACN,mBAAmB;CACb,CAAC;AAUX,6EAA6E;AAC7E,MAAM,IAAI,GAAoB;IAC1B,MAAM,CAAC,OAAO;QACV,MAAM,CAAC,OAAO,CAAC,GAAG,OAAO,CAAC,OAA4C,CAAC;QACvE,MAAM,qBAAqB,GAAG,IAAI,GAAG,CACjC,OAAO,EAAE,aAAa,IAAI,sBAAsB,CACnD,CAAC;QACF,MAAM,uBAAuB,GACzB,OAAO,EAAE,uBAAuB,IAAI,IAAI,CAAC;QAE7C,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,UAAU,GAAG,qBAAqB,CAAC,IAAI,CAAC,CAAC;gBAC/C,MAAM,wBAAwB,GAAG;oBAC7B,GAAG,qBAAqB;iBAC3B,CAAC,IAAI,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,UAAU,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC;gBAEjD,IAAI,CAAC,wBAAwB,EAAE,CAAC;oBAC5B,OAAO;gBACX,CAAC;gBAED,MAAM,eAAe,GAAG,cAAc,CAAC,IAAI,EAAE,aAAa,CAAC,CAAC;gBAE5D,IAAI,eAAe,KAAK,IAAI,EAAE,CAAC;oBAC3B,OAAO,CAAC,MAAM,CAAC;wBACX,SAAS,EAAE,oBAAoB;wBAC/B,IAAI,EAAE,IAAI;qBACb,CAAC,CAAC;oBAEH,OAAO;gBACX,CAAC;gBAED,MAAM,gBAAgB,GAAG,eAAe,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC;gBAEhE,IAAI,gBAAgB,KAAK,IAAI,EAAE,CAAC;oBAC5B,OAAO,CAAC,MAAM,CAAC;wBACX,SAAS,EAAE,oBAAoB;wBAC/B,IAAI,EAAE,eAAe;qBACxB,CAAC,CAAC;oBAEH,OAAO;gBACX,CAAC;gBAED,IAAI,gBAAgB,CAAC,IAAI,KAAK,YAAY,EAAE,CAAC;oBACzC,MAAM,UAAU,GAAG,oBAAoB,CAAC,gBAAgB,CAAC,CAAC;oBAE1D,IAAI,UAAU,KAAK,IAAI,IAAI,UAAU,CAAC,IAAI,EAAE,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;wBACxD,OAAO,CAAC,MAAM,CAAC;4BACX,SAAS,EAAE,oBAAoB;4BAC/B,IAAI,EAAE,gBAAgB;yBACzB,CAAC,CAAC;oBACP,CAAC;oBAED,OAAO;gBACX,CAAC;gBAED,IAAI,gBAAgB,CAAC,IAAI,KAAK,aAAa,EAAE,CAAC;oBAC1C,OAAO,CAAC,MAAM,CAAC;wBACX,SAAS,EAAE,oBAAoB;wBAC/B,IAAI,EAAE,gBAAgB;qBACzB,CAAC,CAAC;oBAEH,OAAO;gBACX,CAAC;gBAED,MAAM,SAAS,GAAG,cAAc,CAAC,gBAAgB,EAAE,OAAO,CAAC,CAAC;gBAC5D,MAAM,UAAU,GAAG,oBAAoB,CACnC,SAAS,EAAE,KAAK,IAAI,IAAI,CAC3B,CAAC;gBAEF,IACI,SAAS,KAAK,IAAI;oBAClB,UAAU,KAAK,IAAI;oBACnB,UAAU,CAAC,IAAI,EAAE,KAAK,EAAE,EAC1B,CAAC;oBACC,OAAO,CAAC,MAAM,CAAC;wBACX,SAAS,EAAE,cAAc;wBACzB,IAAI,EAAE,SAAS,EAAE,GAAG,IAAI,gBAAgB;qBAC3C,CAAC,CAAC;gBACP,CAAC;gBAED,IAAI,CAAC,uBAAuB,EAAE,CAAC;oBAC3B,OAAO;gBACX,CAAC;gBAED,MAAM,oBAAoB,GAAG,cAAc,CACvC,gBAAgB,EAChB,oBAAoB,CACvB,CAAC;gBAEF,IAAI,oBAAoB,KAAK,IAAI,EAAE,CAAC;oBAChC,OAAO,CAAC,MAAM,CAAC;wBACX,SAAS,EAAE,yBAAyB;wBACpC,IAAI,EAAE,gBAAgB;qBACzB,CAAC,CAAC;oBAEH,OAAO;gBACX,CAAC;gBAED,IAAI,wBAAwB,CAAC,oBAAoB,CAAC,KAAK,CAAC,EAAE,CAAC;oBACvD,OAAO;gBACX,CAAC;gBAED,IACI,eAAe,CAAC,oBAAoB,CAAC,KAAK,CAAC,EAAE,IAAI;oBACjD,YAAY,EACd,CAAC;oBACC,OAAO,CAAC,MAAM,CAAC;wBACX,SAAS,EAAE,0BAA0B;wBACrC,IAAI,EACA,oBAAoB,CAAC,KAAK,IAAI,oBAAoB;qBACzD,CAAC,CAAC;oBAEH,OAAO;gBACX,CAAC;gBAED,IAAI,oBAAoB,CAAC,KAAK,EAAE,IAAI,KAAK,YAAY,EAAE,CAAC;oBACpD,OAAO,CAAC,MAAM,CAAC;wBACX,SAAS,EAAE,0BAA0B;wBACrC,IAAI,EACA,oBAAoB,CAAC,KAAK,IAAI,oBAAoB;qBACzD,CAAC,CAAC;oBAEH,OAAO;gBACX,CAAC;gBAED,IAAI,oBAAoB,CAAC,KAAK,CAAC,KAAK,KAAK,IAAI,EAAE,CAAC;oBAC5C,OAAO,CAAC,MAAM,CAAC;wBACX,SAAS,EAAE,0BAA0B;wBACrC,IAAI,EAAE,oBAAoB,CAAC,KAAK;qBACnC,CAAC,CAAC;gBACP,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,+BAA+B;aAClC;YACD,WAAW,EACP,yFAAyF;YAC7F,WAAW,EAAE,KAAK;YAClB,oBAAoB,EAAE,KAAK;YAC3B,MAAM,EAAE,MAAM;YACd,UAAU,EAAE,CAAC;YACb,GAAG,EAAE,qGAAqG;SAC7G;QACD,QAAQ,EAAE;YACN,wBAAwB,EACpB,mHAAmH;YACvH,kBAAkB,EACd,gGAAgG;YACpG,uBAAuB,EACnB,mFAAmF;YACvF,kBAAkB,EACd,kFAAkF;YACtF,YAAY,EACR,kEAAkE;SACzE;QACD,MAAM,EAAE;YACJ;gBACI,oBAAoB,EAAE,KAAK;gBAC3B,WAAW,EACP,yHAAyH;gBAC7H,UAAU,EAAE;oBACR,aAAa,EAAE;wBACX,WAAW,EACP,6EAA6E;wBACjF,KAAK,EAAE;4BACH,SAAS,EAAE,CAAC;4BACZ,IAAI,EAAE,QAAQ;yBACjB;wBACD,IAAI,EAAE,OAAO;wBACb,WAAW,EAAE,IAAI;qBACpB;oBACD,uBAAuB,EAAE;wBACrB,WAAW,EACP,kFAAkF;wBACtF,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 explicit types for `workflow_dispatch` inputs.
|
|
4
|
+
*/
|
|
5
|
+
import type { Rule } from "eslint";
|
|
6
|
+
/** Rule implementation for requiring explicit workflow_dispatch input types. */
|
|
7
|
+
declare const rule: Rule.RuleModule;
|
|
8
|
+
export default rule;
|
|
9
|
+
//# sourceMappingURL=require-workflow-dispatch-input-type.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"require-workflow-dispatch-input-type.d.ts","sourceRoot":"","sources":["../../src/rules/require-workflow-dispatch-input-type.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAUnC,gFAAgF;AAChF,QAAA,MAAM,IAAI,EAAE,IAAI,CAAC,UAmGhB,CAAC;AAEF,eAAe,IAAI,CAAC"}
|
|
@@ -0,0 +1,80 @@
|
|
|
1
|
+
import { getMappingPair, getMappingValueAsMapping, getScalarStringValue, getWorkflowRoot, unwrapYamlValue, } from "../_internal/workflow-yaml.js";
|
|
2
|
+
/** Rule implementation for requiring explicit workflow_dispatch input types. */
|
|
3
|
+
const rule = {
|
|
4
|
+
create(context) {
|
|
5
|
+
return {
|
|
6
|
+
Program() {
|
|
7
|
+
const root = getWorkflowRoot(context);
|
|
8
|
+
if (root === null) {
|
|
9
|
+
return;
|
|
10
|
+
}
|
|
11
|
+
const onMapping = getMappingValueAsMapping(root, "on");
|
|
12
|
+
if (onMapping === null) {
|
|
13
|
+
return;
|
|
14
|
+
}
|
|
15
|
+
const workflowDispatchMapping = unwrapYamlValue(getMappingPair(onMapping, "workflow_dispatch")?.value ??
|
|
16
|
+
null);
|
|
17
|
+
if (workflowDispatchMapping?.type !== "YAMLMapping") {
|
|
18
|
+
return;
|
|
19
|
+
}
|
|
20
|
+
const inputsMapping = getMappingValueAsMapping(workflowDispatchMapping, "inputs");
|
|
21
|
+
if (inputsMapping === null) {
|
|
22
|
+
return;
|
|
23
|
+
}
|
|
24
|
+
for (const pair of inputsMapping.pairs) {
|
|
25
|
+
const inputId = getScalarStringValue(pair.key);
|
|
26
|
+
const inputMapping = unwrapYamlValue(pair.value);
|
|
27
|
+
if (inputId === null ||
|
|
28
|
+
inputMapping?.type !== "YAMLMapping") {
|
|
29
|
+
continue;
|
|
30
|
+
}
|
|
31
|
+
const typePair = getMappingPair(inputMapping, "type");
|
|
32
|
+
if (typePair === null) {
|
|
33
|
+
context.report({
|
|
34
|
+
data: {
|
|
35
|
+
inputId,
|
|
36
|
+
},
|
|
37
|
+
messageId: "missingType",
|
|
38
|
+
node: pair.key,
|
|
39
|
+
});
|
|
40
|
+
continue;
|
|
41
|
+
}
|
|
42
|
+
const typeValue = getScalarStringValue(typePair.value);
|
|
43
|
+
if (typeValue === null || typeValue.trim().length === 0) {
|
|
44
|
+
context.report({
|
|
45
|
+
data: {
|
|
46
|
+
inputId,
|
|
47
|
+
},
|
|
48
|
+
messageId: "invalidType",
|
|
49
|
+
node: (typePair.value ??
|
|
50
|
+
typePair),
|
|
51
|
+
});
|
|
52
|
+
}
|
|
53
|
+
}
|
|
54
|
+
},
|
|
55
|
+
};
|
|
56
|
+
},
|
|
57
|
+
meta: {
|
|
58
|
+
docs: {
|
|
59
|
+
configs: [
|
|
60
|
+
"github-actions.configs.all",
|
|
61
|
+
"github-actions.configs.recommended",
|
|
62
|
+
"github-actions.configs.strict",
|
|
63
|
+
],
|
|
64
|
+
description: "require every `workflow_dispatch` input to declare an explicit `type` so manual runs expose clearer controls and preserve intended value semantics.",
|
|
65
|
+
recommended: true,
|
|
66
|
+
requiresTypeChecking: false,
|
|
67
|
+
ruleId: "R022",
|
|
68
|
+
ruleNumber: 22,
|
|
69
|
+
url: "https://nick2bad4u.github.io/eslint-plugin-github-actions-2/docs/rules/require-workflow-dispatch-input-type",
|
|
70
|
+
},
|
|
71
|
+
messages: {
|
|
72
|
+
invalidType: "`workflow_dispatch` input '{{inputId}}' must set `type` to a non-empty string.",
|
|
73
|
+
missingType: "`workflow_dispatch` input '{{inputId}}' should declare `type` explicitly.",
|
|
74
|
+
},
|
|
75
|
+
schema: [],
|
|
76
|
+
type: "suggestion",
|
|
77
|
+
},
|
|
78
|
+
};
|
|
79
|
+
export default rule;
|
|
80
|
+
//# sourceMappingURL=require-workflow-dispatch-input-type.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"require-workflow-dispatch-input-type.js","sourceRoot":"","sources":["../../src/rules/require-workflow-dispatch-input-type.ts"],"names":[],"mappings":"AAMA,OAAO,EACH,cAAc,EACd,wBAAwB,EACxB,oBAAoB,EACpB,eAAe,EACf,eAAe,GAClB,MAAM,+BAA+B,CAAC;AAEvC,gFAAgF;AAChF,MAAM,IAAI,GAAoB;IAC1B,MAAM,CAAC,OAAO;QACV,OAAO;YACH,OAAO;gBACH,MAAM,IAAI,GAAG,eAAe,CAAC,OAAO,CAAC,CAAC;gBAEtC,IAAI,IAAI,KAAK,IAAI,EAAE,CAAC;oBAChB,OAAO;gBACX,CAAC;gBAED,MAAM,SAAS,GAAG,wBAAwB,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;gBAEvD,IAAI,SAAS,KAAK,IAAI,EAAE,CAAC;oBACrB,OAAO;gBACX,CAAC;gBAED,MAAM,uBAAuB,GAAG,eAAe,CAC3C,cAAc,CAAC,SAAS,EAAE,mBAAmB,CAAC,EAAE,KAAK;oBACjD,IAAI,CACX,CAAC;gBAEF,IAAI,uBAAuB,EAAE,IAAI,KAAK,aAAa,EAAE,CAAC;oBAClD,OAAO;gBACX,CAAC;gBAED,MAAM,aAAa,GAAG,wBAAwB,CAC1C,uBAAuB,EACvB,QAAQ,CACX,CAAC;gBAEF,IAAI,aAAa,KAAK,IAAI,EAAE,CAAC;oBACzB,OAAO;gBACX,CAAC;gBAED,KAAK,MAAM,IAAI,IAAI,aAAa,CAAC,KAAK,EAAE,CAAC;oBACrC,MAAM,OAAO,GAAG,oBAAoB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;oBAC/C,MAAM,YAAY,GAAG,eAAe,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;oBAEjD,IACI,OAAO,KAAK,IAAI;wBAChB,YAAY,EAAE,IAAI,KAAK,aAAa,EACtC,CAAC;wBACC,SAAS;oBACb,CAAC;oBAED,MAAM,QAAQ,GAAG,cAAc,CAAC,YAAY,EAAE,MAAM,CAAC,CAAC;oBAEtD,IAAI,QAAQ,KAAK,IAAI,EAAE,CAAC;wBACpB,OAAO,CAAC,MAAM,CAAC;4BACX,IAAI,EAAE;gCACF,OAAO;6BACV;4BACD,SAAS,EAAE,aAAa;4BACxB,IAAI,EAAE,IAAI,CAAC,GAA2B;yBACzC,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;gCACF,OAAO;6BACV;4BACD,SAAS,EAAE,aAAa;4BACxB,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,oCAAoC;gBACpC,+BAA+B;aAClC;YACD,WAAW,EACP,qJAAqJ;YACzJ,WAAW,EAAE,IAAI;YACjB,oBAAoB,EAAE,KAAK;YAC3B,MAAM,EAAE,MAAM;YACd,UAAU,EAAE,EAAE;YACd,GAAG,EAAE,6GAA6G;SACrH;QACD,QAAQ,EAAE;YACN,WAAW,EACP,gFAAgF;YACpF,WAAW,EACP,2EAA2E;SAClF;QACD,MAAM,EAAE,EAAE;QACV,IAAI,EAAE,YAAY;KACA;CACzB,CAAC;AAEF,eAAe,IAAI,CAAC"}
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @packageDocumentation
|
|
3
|
+
* Require descriptions for manual and reusable workflow interfaces.
|
|
4
|
+
*/
|
|
5
|
+
import type { Rule } from "eslint";
|
|
6
|
+
/** Rule implementation for requiring workflow interface descriptions. */
|
|
7
|
+
declare const rule: Rule.RuleModule;
|
|
8
|
+
export default rule;
|
|
9
|
+
//# sourceMappingURL=require-workflow-interface-description.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"require-workflow-interface-description.d.ts","sourceRoot":"","sources":["../../src/rules/require-workflow-interface-description.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAwDnC,yEAAyE;AACzE,QAAA,MAAM,IAAI,EAAE,IAAI,CAAC,UA4GhB,CAAC;AAEF,eAAe,IAAI,CAAC"}
|
|
@@ -0,0 +1,98 @@
|
|
|
1
|
+
import { getMappingPair, getMappingValueAsMapping, getScalarStringValue, getWorkflowRoot, unwrapYamlValue, } from "../_internal/workflow-yaml.js";
|
|
2
|
+
/** Report missing or invalid descriptions across interface mappings. */
|
|
3
|
+
const checkInterfaceDescriptions = (context, mapping, kind) => {
|
|
4
|
+
for (const pair of mapping.pairs) {
|
|
5
|
+
const name = getScalarStringValue(pair.key);
|
|
6
|
+
const entryMapping = unwrapYamlValue(pair.value);
|
|
7
|
+
if (name === null || entryMapping?.type !== "YAMLMapping") {
|
|
8
|
+
continue;
|
|
9
|
+
}
|
|
10
|
+
const descriptionPair = getMappingPair(entryMapping, "description");
|
|
11
|
+
if (descriptionPair === null) {
|
|
12
|
+
context.report({
|
|
13
|
+
data: {
|
|
14
|
+
kind,
|
|
15
|
+
name,
|
|
16
|
+
},
|
|
17
|
+
messageId: "missingDescription",
|
|
18
|
+
node: pair.key,
|
|
19
|
+
});
|
|
20
|
+
continue;
|
|
21
|
+
}
|
|
22
|
+
const descriptionValue = getScalarStringValue(descriptionPair.value);
|
|
23
|
+
if (descriptionValue === null || descriptionValue.trim().length === 0) {
|
|
24
|
+
context.report({
|
|
25
|
+
data: {
|
|
26
|
+
kind,
|
|
27
|
+
name,
|
|
28
|
+
},
|
|
29
|
+
messageId: "invalidDescription",
|
|
30
|
+
node: (descriptionPair.value ??
|
|
31
|
+
descriptionPair),
|
|
32
|
+
});
|
|
33
|
+
}
|
|
34
|
+
}
|
|
35
|
+
};
|
|
36
|
+
/** Rule implementation for requiring workflow interface descriptions. */
|
|
37
|
+
const rule = {
|
|
38
|
+
create(context) {
|
|
39
|
+
return {
|
|
40
|
+
Program() {
|
|
41
|
+
const root = getWorkflowRoot(context);
|
|
42
|
+
if (root === null) {
|
|
43
|
+
return;
|
|
44
|
+
}
|
|
45
|
+
const onMapping = getMappingValueAsMapping(root, "on");
|
|
46
|
+
if (onMapping === null) {
|
|
47
|
+
return;
|
|
48
|
+
}
|
|
49
|
+
const workflowDispatchMapping = unwrapYamlValue(getMappingPair(onMapping, "workflow_dispatch")?.value ??
|
|
50
|
+
null);
|
|
51
|
+
if (workflowDispatchMapping?.type === "YAMLMapping") {
|
|
52
|
+
const dispatchInputsMapping = getMappingValueAsMapping(workflowDispatchMapping, "inputs");
|
|
53
|
+
if (dispatchInputsMapping !== null) {
|
|
54
|
+
checkInterfaceDescriptions(context, dispatchInputsMapping, "workflow_dispatch input");
|
|
55
|
+
}
|
|
56
|
+
}
|
|
57
|
+
const workflowCallMapping = unwrapYamlValue(getMappingPair(onMapping, "workflow_call")?.value ?? null);
|
|
58
|
+
if (workflowCallMapping?.type !== "YAMLMapping") {
|
|
59
|
+
return;
|
|
60
|
+
}
|
|
61
|
+
const workflowCallInputsMapping = getMappingValueAsMapping(workflowCallMapping, "inputs");
|
|
62
|
+
if (workflowCallInputsMapping !== null) {
|
|
63
|
+
checkInterfaceDescriptions(context, workflowCallInputsMapping, "workflow_call input");
|
|
64
|
+
}
|
|
65
|
+
const workflowCallSecretsMapping = getMappingValueAsMapping(workflowCallMapping, "secrets");
|
|
66
|
+
if (workflowCallSecretsMapping !== null) {
|
|
67
|
+
checkInterfaceDescriptions(context, workflowCallSecretsMapping, "workflow_call secret");
|
|
68
|
+
}
|
|
69
|
+
const workflowCallOutputsMapping = getMappingValueAsMapping(workflowCallMapping, "outputs");
|
|
70
|
+
if (workflowCallOutputsMapping !== null) {
|
|
71
|
+
checkInterfaceDescriptions(context, workflowCallOutputsMapping, "workflow_call output");
|
|
72
|
+
}
|
|
73
|
+
},
|
|
74
|
+
};
|
|
75
|
+
},
|
|
76
|
+
meta: {
|
|
77
|
+
docs: {
|
|
78
|
+
configs: [
|
|
79
|
+
"github-actions.configs.all",
|
|
80
|
+
"github-actions.configs.strict",
|
|
81
|
+
],
|
|
82
|
+
description: "require descriptions for `workflow_dispatch` inputs and reusable workflow interfaces so manual forms and callable workflows stay self-documenting.",
|
|
83
|
+
recommended: false,
|
|
84
|
+
requiresTypeChecking: false,
|
|
85
|
+
ruleId: "R024",
|
|
86
|
+
ruleNumber: 24,
|
|
87
|
+
url: "https://nick2bad4u.github.io/eslint-plugin-github-actions-2/docs/rules/require-workflow-interface-description",
|
|
88
|
+
},
|
|
89
|
+
messages: {
|
|
90
|
+
invalidDescription: "{{kind}} '{{name}}' must set `description` to a non-empty string.",
|
|
91
|
+
missingDescription: "{{kind}} '{{name}}' should declare `description` explicitly.",
|
|
92
|
+
},
|
|
93
|
+
schema: [],
|
|
94
|
+
type: "suggestion",
|
|
95
|
+
},
|
|
96
|
+
};
|
|
97
|
+
export default rule;
|
|
98
|
+
//# sourceMappingURL=require-workflow-interface-description.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"require-workflow-interface-description.js","sourceRoot":"","sources":["../../src/rules/require-workflow-interface-description.ts"],"names":[],"mappings":"AAOA,OAAO,EACH,cAAc,EACd,wBAAwB,EACxB,oBAAoB,EACpB,eAAe,EACf,eAAe,GAClB,MAAM,+BAA+B,CAAC;AAEvC,wEAAwE;AACxE,MAAM,0BAA0B,GAAG,CAC/B,OAAmC,EACnC,OAAkC,EAClC,IAAY,EACR,EAAE;IACN,KAAK,MAAM,IAAI,IAAI,OAAO,CAAC,KAAK,EAAE,CAAC;QAC/B,MAAM,IAAI,GAAG,oBAAoB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAC5C,MAAM,YAAY,GAAG,eAAe,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAEjD,IAAI,IAAI,KAAK,IAAI,IAAI,YAAY,EAAE,IAAI,KAAK,aAAa,EAAE,CAAC;YACxD,SAAS;QACb,CAAC;QAED,MAAM,eAAe,GAAG,cAAc,CAAC,YAAY,EAAE,aAAa,CAAC,CAAC;QAEpE,IAAI,eAAe,KAAK,IAAI,EAAE,CAAC;YAC3B,OAAO,CAAC,MAAM,CAAC;gBACX,IAAI,EAAE;oBACF,IAAI;oBACJ,IAAI;iBACP;gBACD,SAAS,EAAE,oBAAoB;gBAC/B,IAAI,EAAE,IAAI,CAAC,GAA2B;aACzC,CAAC,CAAC;YAEH,SAAS;QACb,CAAC;QAED,MAAM,gBAAgB,GAAG,oBAAoB,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC;QAErE,IAAI,gBAAgB,KAAK,IAAI,IAAI,gBAAgB,CAAC,IAAI,EAAE,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACpE,OAAO,CAAC,MAAM,CAAC;gBACX,IAAI,EAAE;oBACF,IAAI;oBACJ,IAAI;iBACP;gBACD,SAAS,EAAE,oBAAoB;gBAC/B,IAAI,EAAE,CAAC,eAAe,CAAC,KAAK;oBACxB,eAAe,CAAyB;aAC/C,CAAC,CAAC;QACP,CAAC;IACL,CAAC;AACL,CAAC,CAAC;AAEF,yEAAyE;AACzE,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,uBAAuB,GAAG,eAAe,CAC3C,cAAc,CAAC,SAAS,EAAE,mBAAmB,CAAC,EAAE,KAAK;oBACjD,IAAI,CACX,CAAC;gBAEF,IAAI,uBAAuB,EAAE,IAAI,KAAK,aAAa,EAAE,CAAC;oBAClD,MAAM,qBAAqB,GAAG,wBAAwB,CAClD,uBAAuB,EACvB,QAAQ,CACX,CAAC;oBAEF,IAAI,qBAAqB,KAAK,IAAI,EAAE,CAAC;wBACjC,0BAA0B,CACtB,OAAO,EACP,qBAAqB,EACrB,yBAAyB,CAC5B,CAAC;oBACN,CAAC;gBACL,CAAC;gBAED,MAAM,mBAAmB,GAAG,eAAe,CACvC,cAAc,CAAC,SAAS,EAAE,eAAe,CAAC,EAAE,KAAK,IAAI,IAAI,CAC5D,CAAC;gBAEF,IAAI,mBAAmB,EAAE,IAAI,KAAK,aAAa,EAAE,CAAC;oBAC9C,OAAO;gBACX,CAAC;gBAED,MAAM,yBAAyB,GAAG,wBAAwB,CACtD,mBAAmB,EACnB,QAAQ,CACX,CAAC;gBAEF,IAAI,yBAAyB,KAAK,IAAI,EAAE,CAAC;oBACrC,0BAA0B,CACtB,OAAO,EACP,yBAAyB,EACzB,qBAAqB,CACxB,CAAC;gBACN,CAAC;gBAED,MAAM,0BAA0B,GAAG,wBAAwB,CACvD,mBAAmB,EACnB,SAAS,CACZ,CAAC;gBAEF,IAAI,0BAA0B,KAAK,IAAI,EAAE,CAAC;oBACtC,0BAA0B,CACtB,OAAO,EACP,0BAA0B,EAC1B,sBAAsB,CACzB,CAAC;gBACN,CAAC;gBAED,MAAM,0BAA0B,GAAG,wBAAwB,CACvD,mBAAmB,EACnB,SAAS,CACZ,CAAC;gBAEF,IAAI,0BAA0B,KAAK,IAAI,EAAE,CAAC;oBACtC,0BAA0B,CACtB,OAAO,EACP,0BAA0B,EAC1B,sBAAsB,CACzB,CAAC;gBACN,CAAC;YACL,CAAC;SACJ,CAAC;IACN,CAAC;IACD,IAAI,EAAE;QACF,IAAI,EAAE;YACF,OAAO,EAAE;gBACL,4BAA4B;gBAC5B,+BAA+B;aAClC;YACD,WAAW,EACP,oJAAoJ;YACxJ,WAAW,EAAE,KAAK;YAClB,oBAAoB,EAAE,KAAK;YAC3B,MAAM,EAAE,MAAM;YACd,UAAU,EAAE,EAAE;YACd,GAAG,EAAE,+GAA+G;SACvH;QACD,QAAQ,EAAE;YACN,kBAAkB,EACd,mEAAmE;YACvE,kBAAkB,EACd,8DAA8D;SACrE;QACD,MAAM,EAAE,EAAE;QACV,IAAI,EAAE,YAAY;KACA;CACzB,CAAC;AAEF,eAAe,IAAI,CAAC"}
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @packageDocumentation
|
|
3
|
+
* Require explicit GitHub token permissions at workflow or job scope.
|
|
4
|
+
*/
|
|
5
|
+
import type { Rule } from "eslint";
|
|
6
|
+
/** Rule implementation for requiring explicit workflow or job token permissions. */
|
|
7
|
+
declare const rule: Rule.RuleModule;
|
|
8
|
+
export default rule;
|
|
9
|
+
//# sourceMappingURL=require-workflow-permissions.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"require-workflow-permissions.d.ts","sourceRoot":"","sources":["../../src/rules/require-workflow-permissions.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAenC,oFAAoF;AACpF,QAAA,MAAM,IAAI,EAAE,IAAI,CAAC,UA8FhB,CAAC;AAEF,eAAe,IAAI,CAAC"}
|
|
@@ -0,0 +1,83 @@
|
|
|
1
|
+
import { getMappingPair, getWorkflowJobs, getWorkflowRoot, } from "../_internal/workflow-yaml.js";
|
|
2
|
+
/** Rule implementation for requiring explicit workflow or job token permissions. */
|
|
3
|
+
const rule = {
|
|
4
|
+
create(context) {
|
|
5
|
+
const [options] = context.options;
|
|
6
|
+
const allowJobLevelPermissions = options?.allowJobLevelPermissions ?? true;
|
|
7
|
+
return {
|
|
8
|
+
Program() {
|
|
9
|
+
const root = getWorkflowRoot(context);
|
|
10
|
+
if (root === null) {
|
|
11
|
+
return;
|
|
12
|
+
}
|
|
13
|
+
if (getMappingPair(root, "permissions") !== null) {
|
|
14
|
+
return;
|
|
15
|
+
}
|
|
16
|
+
const jobs = getWorkflowJobs(root);
|
|
17
|
+
if (!allowJobLevelPermissions) {
|
|
18
|
+
context.report({
|
|
19
|
+
messageId: "missingWorkflowPermissions",
|
|
20
|
+
node: root,
|
|
21
|
+
});
|
|
22
|
+
return;
|
|
23
|
+
}
|
|
24
|
+
if (jobs.length === 0) {
|
|
25
|
+
context.report({
|
|
26
|
+
messageId: "missingWorkflowPermissions",
|
|
27
|
+
node: root,
|
|
28
|
+
});
|
|
29
|
+
return;
|
|
30
|
+
}
|
|
31
|
+
for (const job of jobs) {
|
|
32
|
+
if (getMappingPair(job.mapping, "permissions") !== null) {
|
|
33
|
+
continue;
|
|
34
|
+
}
|
|
35
|
+
context.report({
|
|
36
|
+
data: {
|
|
37
|
+
jobId: job.id,
|
|
38
|
+
},
|
|
39
|
+
messageId: "missingJobPermissions",
|
|
40
|
+
node: job.idNode,
|
|
41
|
+
});
|
|
42
|
+
}
|
|
43
|
+
},
|
|
44
|
+
};
|
|
45
|
+
},
|
|
46
|
+
meta: {
|
|
47
|
+
defaultOptions: [{}],
|
|
48
|
+
docs: {
|
|
49
|
+
configs: [
|
|
50
|
+
"github-actions.configs.all",
|
|
51
|
+
"github-actions.configs.recommended",
|
|
52
|
+
"github-actions.configs.security",
|
|
53
|
+
"github-actions.configs.strict",
|
|
54
|
+
],
|
|
55
|
+
description: "require explicit `permissions` to avoid relying on GitHub Actions' default token scope.",
|
|
56
|
+
recommended: true,
|
|
57
|
+
requiresTypeChecking: false,
|
|
58
|
+
ruleId: "R001",
|
|
59
|
+
ruleNumber: 1,
|
|
60
|
+
url: "https://nick2bad4u.github.io/eslint-plugin-github-actions-2/docs/rules/require-workflow-permissions",
|
|
61
|
+
},
|
|
62
|
+
messages: {
|
|
63
|
+
missingJobPermissions: "Job '{{jobId}}' is missing explicit `permissions`. Define workflow-level `permissions` or add `jobs.{{jobId}}.permissions`.",
|
|
64
|
+
missingWorkflowPermissions: "Define explicit top-level `permissions` for this workflow, or configure job-level `permissions` for every job.",
|
|
65
|
+
},
|
|
66
|
+
schema: [
|
|
67
|
+
{
|
|
68
|
+
additionalProperties: false,
|
|
69
|
+
description: "Optional configuration for how strictly workflow permissions must be declared.",
|
|
70
|
+
properties: {
|
|
71
|
+
allowJobLevelPermissions: {
|
|
72
|
+
description: "Allow each job to declare its own permissions when the workflow omits a top-level permissions block.",
|
|
73
|
+
type: "boolean",
|
|
74
|
+
},
|
|
75
|
+
},
|
|
76
|
+
type: "object",
|
|
77
|
+
},
|
|
78
|
+
],
|
|
79
|
+
type: "suggestion",
|
|
80
|
+
},
|
|
81
|
+
};
|
|
82
|
+
export default rule;
|
|
83
|
+
//# sourceMappingURL=require-workflow-permissions.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"require-workflow-permissions.js","sourceRoot":"","sources":["../../src/rules/require-workflow-permissions.ts"],"names":[],"mappings":"AAMA,OAAO,EACH,cAAc,EACd,eAAe,EACf,eAAe,GAClB,MAAM,+BAA+B,CAAC;AASvC,oFAAoF;AACpF,MAAM,IAAI,GAAoB;IAC1B,MAAM,CAAC,OAAO;QACV,MAAM,CAAC,OAAO,CAAC,GAAG,OAAO,CAAC,OAA4C,CAAC;QACvE,MAAM,wBAAwB,GAC1B,OAAO,EAAE,wBAAwB,IAAI,IAAI,CAAC;QAE9C,OAAO;YACH,OAAO;gBACH,MAAM,IAAI,GAAG,eAAe,CAAC,OAAO,CAAC,CAAC;gBAEtC,IAAI,IAAI,KAAK,IAAI,EAAE,CAAC;oBAChB,OAAO;gBACX,CAAC;gBAED,IAAI,cAAc,CAAC,IAAI,EAAE,aAAa,CAAC,KAAK,IAAI,EAAE,CAAC;oBAC/C,OAAO;gBACX,CAAC;gBAED,MAAM,IAAI,GAAG,eAAe,CAAC,IAAI,CAAC,CAAC;gBAEnC,IAAI,CAAC,wBAAwB,EAAE,CAAC;oBAC5B,OAAO,CAAC,MAAM,CAAC;wBACX,SAAS,EAAE,4BAA4B;wBACvC,IAAI,EAAE,IAAI;qBACb,CAAC,CAAC;oBAEH,OAAO;gBACX,CAAC;gBAED,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;oBACpB,OAAO,CAAC,MAAM,CAAC;wBACX,SAAS,EAAE,4BAA4B;wBACvC,IAAI,EAAE,IAAI;qBACb,CAAC,CAAC;oBAEH,OAAO;gBACX,CAAC;gBAED,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;oBACrB,IAAI,cAAc,CAAC,GAAG,CAAC,OAAO,EAAE,aAAa,CAAC,KAAK,IAAI,EAAE,CAAC;wBACtD,SAAS;oBACb,CAAC;oBAED,OAAO,CAAC,MAAM,CAAC;wBACX,IAAI,EAAE;4BACF,KAAK,EAAE,GAAG,CAAC,EAAE;yBAChB;wBACD,SAAS,EAAE,uBAAuB;wBAClC,IAAI,EAAE,GAAG,CAAC,MAAM;qBACnB,CAAC,CAAC;gBACP,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,iCAAiC;gBACjC,+BAA+B;aAClC;YACD,WAAW,EACP,yFAAyF;YAC7F,WAAW,EAAE,IAAI;YACjB,oBAAoB,EAAE,KAAK;YAC3B,MAAM,EAAE,MAAM;YACd,UAAU,EAAE,CAAC;YACb,GAAG,EAAE,qGAAqG;SAC7G;QACD,QAAQ,EAAE;YACN,qBAAqB,EACjB,6HAA6H;YACjI,0BAA0B,EACtB,gHAAgH;SACvH;QACD,MAAM,EAAE;YACJ;gBACI,oBAAoB,EAAE,KAAK;gBAC3B,WAAW,EACP,gFAAgF;gBACpF,UAAU,EAAE;oBACR,wBAAwB,EAAE;wBACtB,WAAW,EACP,sGAAsG;wBAC1G,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 branch scoping for `workflow_run` triggers.
|
|
4
|
+
*/
|
|
5
|
+
import type { Rule } from "eslint";
|
|
6
|
+
/** Rule implementation for requiring `workflow_run` branch filters. */
|
|
7
|
+
declare const rule: Rule.RuleModule;
|
|
8
|
+
export default rule;
|
|
9
|
+
//# sourceMappingURL=require-workflow-run-branches.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"require-workflow-run-branches.d.ts","sourceRoot":"","sources":["../../src/rules/require-workflow-run-branches.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAyCnC,uEAAuE;AACvE,QAAA,MAAM,IAAI,EAAE,IAAI,CAAC,UAmFhB,CAAC;AAEF,eAAe,IAAI,CAAC"}
|