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,209 @@
|
|
|
1
|
+
import { getMappingPair, getMappingValueAsSequence, getScalarStringValue, getWorkflowJobs, getWorkflowRoot, unwrapYamlValue, } from "../_internal/workflow-yaml.js";
|
|
2
|
+
/** Supported `uses:` reference styles. */
|
|
3
|
+
const usesStyles = [
|
|
4
|
+
"branch",
|
|
5
|
+
"commit",
|
|
6
|
+
"release",
|
|
7
|
+
];
|
|
8
|
+
/** Default `uses:` style enforced by the rule. */
|
|
9
|
+
const DEFAULT_STEP_USES_STYLE = "commit";
|
|
10
|
+
/** Normalize prefer-step-uses-style options into a consistent runtime shape. */
|
|
11
|
+
const normalizeStepUsesStyleOptions = (option) => {
|
|
12
|
+
if (option === undefined || typeof option === "string") {
|
|
13
|
+
return {
|
|
14
|
+
allowDocker: false,
|
|
15
|
+
allowedStyles: [option ?? DEFAULT_STEP_USES_STYLE],
|
|
16
|
+
allowRepository: false,
|
|
17
|
+
ignoredReferences: [],
|
|
18
|
+
};
|
|
19
|
+
}
|
|
20
|
+
const allowedStyles = usesStyles.filter((style) => option[style] === true);
|
|
21
|
+
return {
|
|
22
|
+
allowDocker: option.allowDocker ?? false,
|
|
23
|
+
allowedStyles: allowedStyles.length > 0
|
|
24
|
+
? allowedStyles
|
|
25
|
+
: [DEFAULT_STEP_USES_STYLE],
|
|
26
|
+
allowRepository: option.allowRepository ?? false,
|
|
27
|
+
ignoredReferences: [...(option.ignores ?? [])],
|
|
28
|
+
};
|
|
29
|
+
};
|
|
30
|
+
/** Parse a step-level `uses:` reference into its normalized style. */
|
|
31
|
+
const parseStepUsesReference = (reference) => {
|
|
32
|
+
if (reference.startsWith("./")) {
|
|
33
|
+
return {
|
|
34
|
+
isDocker: false,
|
|
35
|
+
isRepository: true,
|
|
36
|
+
style: DEFAULT_STEP_USES_STYLE,
|
|
37
|
+
};
|
|
38
|
+
}
|
|
39
|
+
if (reference.startsWith("docker://")) {
|
|
40
|
+
return {
|
|
41
|
+
isDocker: true,
|
|
42
|
+
isRepository: false,
|
|
43
|
+
style: DEFAULT_STEP_USES_STYLE,
|
|
44
|
+
};
|
|
45
|
+
}
|
|
46
|
+
const delimiterIndex = reference.lastIndexOf("@");
|
|
47
|
+
const ref = delimiterIndex === -1 ? "" : reference.slice(delimiterIndex + 1);
|
|
48
|
+
let isReleaseStyle = ref.startsWith("v") && ref.length > 1;
|
|
49
|
+
if (isReleaseStyle) {
|
|
50
|
+
for (const character of ref.slice(1)) {
|
|
51
|
+
if (character !== "." && (character < "0" || character > "9")) {
|
|
52
|
+
isReleaseStyle = false;
|
|
53
|
+
break;
|
|
54
|
+
}
|
|
55
|
+
}
|
|
56
|
+
}
|
|
57
|
+
if (/^[0-9a-f]{40}$/u.test(ref)) {
|
|
58
|
+
return {
|
|
59
|
+
isDocker: false,
|
|
60
|
+
isRepository: false,
|
|
61
|
+
style: "commit",
|
|
62
|
+
};
|
|
63
|
+
}
|
|
64
|
+
if (isReleaseStyle) {
|
|
65
|
+
return {
|
|
66
|
+
isDocker: false,
|
|
67
|
+
isRepository: false,
|
|
68
|
+
style: "release",
|
|
69
|
+
};
|
|
70
|
+
}
|
|
71
|
+
return {
|
|
72
|
+
isDocker: false,
|
|
73
|
+
isRepository: false,
|
|
74
|
+
style: "branch",
|
|
75
|
+
};
|
|
76
|
+
};
|
|
77
|
+
/** Rule implementation for enforcing step-level `uses:` reference style. */
|
|
78
|
+
const rule = {
|
|
79
|
+
create(context) {
|
|
80
|
+
const [option] = context.options;
|
|
81
|
+
const { allowDocker, allowedStyles, allowRepository, ignoredReferences, } = normalizeStepUsesStyleOptions(option ?? undefined);
|
|
82
|
+
return {
|
|
83
|
+
Program() {
|
|
84
|
+
const root = getWorkflowRoot(context);
|
|
85
|
+
if (root === null) {
|
|
86
|
+
return;
|
|
87
|
+
}
|
|
88
|
+
for (const job of getWorkflowJobs(root)) {
|
|
89
|
+
const stepsSequence = getMappingValueAsSequence(job.mapping, "steps");
|
|
90
|
+
if (stepsSequence === null) {
|
|
91
|
+
continue;
|
|
92
|
+
}
|
|
93
|
+
for (const entry of stepsSequence.entries) {
|
|
94
|
+
const stepMapping = unwrapYamlValue(entry);
|
|
95
|
+
if (stepMapping?.type !== "YAMLMapping") {
|
|
96
|
+
continue;
|
|
97
|
+
}
|
|
98
|
+
const usesPair = getMappingPair(stepMapping, "uses");
|
|
99
|
+
const usesReference = getScalarStringValue(usesPair?.value ?? null);
|
|
100
|
+
if (usesPair === null || usesReference === null) {
|
|
101
|
+
continue;
|
|
102
|
+
}
|
|
103
|
+
if (ignoredReferences.includes(usesReference)) {
|
|
104
|
+
continue;
|
|
105
|
+
}
|
|
106
|
+
const parsedReference = parseStepUsesReference(usesReference);
|
|
107
|
+
if (parsedReference.isRepository) {
|
|
108
|
+
if (!allowRepository) {
|
|
109
|
+
context.report({
|
|
110
|
+
messageId: "repositoryActionDisallowed",
|
|
111
|
+
node: (usesPair.value ??
|
|
112
|
+
usesPair),
|
|
113
|
+
});
|
|
114
|
+
}
|
|
115
|
+
continue;
|
|
116
|
+
}
|
|
117
|
+
if (parsedReference.isDocker) {
|
|
118
|
+
if (!allowDocker) {
|
|
119
|
+
context.report({
|
|
120
|
+
messageId: "dockerActionDisallowed",
|
|
121
|
+
node: (usesPair.value ??
|
|
122
|
+
usesPair),
|
|
123
|
+
});
|
|
124
|
+
}
|
|
125
|
+
continue;
|
|
126
|
+
}
|
|
127
|
+
if (!allowedStyles.includes(parsedReference.style)) {
|
|
128
|
+
context.report({
|
|
129
|
+
data: {
|
|
130
|
+
style: parsedReference.style,
|
|
131
|
+
},
|
|
132
|
+
messageId: "styleDisallowed",
|
|
133
|
+
node: (usesPair.value ??
|
|
134
|
+
usesPair),
|
|
135
|
+
});
|
|
136
|
+
}
|
|
137
|
+
}
|
|
138
|
+
}
|
|
139
|
+
},
|
|
140
|
+
};
|
|
141
|
+
},
|
|
142
|
+
meta: {
|
|
143
|
+
defaultOptions: [DEFAULT_STEP_USES_STYLE],
|
|
144
|
+
docs: {
|
|
145
|
+
configs: ["github-actions.configs.all"],
|
|
146
|
+
description: "enforce a consistent style for step-level `uses` references.",
|
|
147
|
+
recommended: false,
|
|
148
|
+
requiresTypeChecking: false,
|
|
149
|
+
ruleId: "R016",
|
|
150
|
+
ruleNumber: 16,
|
|
151
|
+
url: "https://nick2bad4u.github.io/eslint-plugin-github-actions-2/docs/rules/prefer-step-uses-style",
|
|
152
|
+
},
|
|
153
|
+
messages: {
|
|
154
|
+
dockerActionDisallowed: "Docker-based `uses` references are disallowed by this rule configuration.",
|
|
155
|
+
repositoryActionDisallowed: "Repository-local `uses` references are disallowed by this rule configuration.",
|
|
156
|
+
styleDisallowed: "Step `uses` references with style '{{style}}' are disallowed by this rule configuration.",
|
|
157
|
+
},
|
|
158
|
+
schema: [
|
|
159
|
+
{
|
|
160
|
+
anyOf: [
|
|
161
|
+
{
|
|
162
|
+
description: "Single allowed style for step-level `uses` references.",
|
|
163
|
+
enum: usesStyles,
|
|
164
|
+
type: "string",
|
|
165
|
+
},
|
|
166
|
+
{
|
|
167
|
+
additionalProperties: false,
|
|
168
|
+
description: "Allowed styles and exceptions for step-level `uses` references.",
|
|
169
|
+
properties: {
|
|
170
|
+
allowDocker: {
|
|
171
|
+
description: "Allow Docker-based step `uses` references such as docker://alpine:3.20.",
|
|
172
|
+
type: "boolean",
|
|
173
|
+
},
|
|
174
|
+
allowRepository: {
|
|
175
|
+
description: "Allow repository-local step `uses` references such as ./.github/actions/foo.",
|
|
176
|
+
type: "boolean",
|
|
177
|
+
},
|
|
178
|
+
branch: {
|
|
179
|
+
description: "Allow branch-style references such as @main.",
|
|
180
|
+
type: "boolean",
|
|
181
|
+
},
|
|
182
|
+
commit: {
|
|
183
|
+
description: "Allow full-commit-SHA references such as @0123...abcd.",
|
|
184
|
+
type: "boolean",
|
|
185
|
+
},
|
|
186
|
+
ignores: {
|
|
187
|
+
description: "Literal step `uses` references that should be ignored by this rule.",
|
|
188
|
+
items: {
|
|
189
|
+
type: "string",
|
|
190
|
+
},
|
|
191
|
+
type: "array",
|
|
192
|
+
uniqueItems: true,
|
|
193
|
+
},
|
|
194
|
+
release: {
|
|
195
|
+
description: "Allow release-style references such as @v4 or @v4.2.0.",
|
|
196
|
+
type: "boolean",
|
|
197
|
+
},
|
|
198
|
+
},
|
|
199
|
+
type: "object",
|
|
200
|
+
},
|
|
201
|
+
],
|
|
202
|
+
description: "Configure the allowed styles for step-level `uses` references.",
|
|
203
|
+
},
|
|
204
|
+
],
|
|
205
|
+
type: "suggestion",
|
|
206
|
+
},
|
|
207
|
+
};
|
|
208
|
+
export default rule;
|
|
209
|
+
//# sourceMappingURL=prefer-step-uses-style.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"prefer-step-uses-style.js","sourceRoot":"","sources":["../../src/rules/prefer-step-uses-style.ts"],"names":[],"mappings":"AAMA,OAAO,EACH,cAAc,EACd,yBAAyB,EACzB,oBAAoB,EACpB,eAAe,EACf,eAAe,EACf,eAAe,GAClB,MAAM,+BAA+B,CAAC;AAEvC,0CAA0C;AAC1C,MAAM,UAAU,GAAG;IACf,QAAQ;IACR,QAAQ;IACR,SAAS;CACH,CAAC;AAcX,kDAAkD;AAClD,MAAM,uBAAuB,GAAkB,QAAQ,CAAC;AAExD,gFAAgF;AAChF,MAAM,6BAA6B,GAAG,CAClC,MAEC,EAMH,EAAE;IACA,IAAI,MAAM,KAAK,SAAS,IAAI,OAAO,MAAM,KAAK,QAAQ,EAAE,CAAC;QACrD,OAAO;YACH,WAAW,EAAE,KAAK;YAClB,aAAa,EAAE,CAAC,MAAM,IAAI,uBAAuB,CAAC;YAClD,eAAe,EAAE,KAAK;YACtB,iBAAiB,EAAE,EAAE;SACxB,CAAC;IACN,CAAC;IAED,MAAM,aAAa,GAAG,UAAU,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,IAAI,CAAC,CAAC;IAE3E,OAAO;QACH,WAAW,EAAE,MAAM,CAAC,WAAW,IAAI,KAAK;QACxC,aAAa,EACT,aAAa,CAAC,MAAM,GAAG,CAAC;YACpB,CAAC,CAAC,aAAa;YACf,CAAC,CAAC,CAAC,uBAAuB,CAAC;QACnC,eAAe,EAAE,MAAM,CAAC,eAAe,IAAI,KAAK;QAChD,iBAAiB,EAAE,CAAC,GAAG,CAAC,MAAM,CAAC,OAAO,IAAI,EAAE,CAAC,CAAC;KACjD,CAAC;AACN,CAAC,CAAC;AAEF,sEAAsE;AACtE,MAAM,sBAAsB,GAAG,CAC3B,SAAiB,EAKnB,EAAE;IACA,IAAI,SAAS,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC;QAC7B,OAAO;YACH,QAAQ,EAAE,KAAK;YACf,YAAY,EAAE,IAAI;YAClB,KAAK,EAAE,uBAAuB;SACjC,CAAC;IACN,CAAC;IAED,IAAI,SAAS,CAAC,UAAU,CAAC,WAAW,CAAC,EAAE,CAAC;QACpC,OAAO;YACH,QAAQ,EAAE,IAAI;YACd,YAAY,EAAE,KAAK;YACnB,KAAK,EAAE,uBAAuB;SACjC,CAAC;IACN,CAAC;IAED,MAAM,cAAc,GAAG,SAAS,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;IAClD,MAAM,GAAG,GACL,cAAc,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,KAAK,CAAC,cAAc,GAAG,CAAC,CAAC,CAAC;IAErE,IAAI,cAAc,GAAG,GAAG,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,GAAG,CAAC,MAAM,GAAG,CAAC,CAAC;IAE3D,IAAI,cAAc,EAAE,CAAC;QACjB,KAAK,MAAM,SAAS,IAAI,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC;YACnC,IAAI,SAAS,KAAK,GAAG,IAAI,CAAC,SAAS,GAAG,GAAG,IAAI,SAAS,GAAG,GAAG,CAAC,EAAE,CAAC;gBAC5D,cAAc,GAAG,KAAK,CAAC;gBACvB,MAAM;YACV,CAAC;QACL,CAAC;IACL,CAAC;IAED,IAAI,iBAAiB,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;QAC9B,OAAO;YACH,QAAQ,EAAE,KAAK;YACf,YAAY,EAAE,KAAK;YACnB,KAAK,EAAE,QAAQ;SAClB,CAAC;IACN,CAAC;IAED,IAAI,cAAc,EAAE,CAAC;QACjB,OAAO;YACH,QAAQ,EAAE,KAAK;YACf,YAAY,EAAE,KAAK;YACnB,KAAK,EAAE,SAAS;SACnB,CAAC;IACN,CAAC;IAED,OAAO;QACH,QAAQ,EAAE,KAAK;QACf,YAAY,EAAE,KAAK;QACnB,KAAK,EAAE,QAAQ;KAClB,CAAC;AACN,CAAC,CAAC;AAEF,4EAA4E;AAC5E,MAAM,IAAI,GAAoB;IAC1B,MAAM,CAAC,OAAO;QACV,MAAM,CAAC,MAAM,CAAC,GAAG,OAAO,CAAC,OAExB,CAAC;QACF,MAAM,EACF,WAAW,EACX,aAAa,EACb,eAAe,EACf,iBAAiB,GACpB,GAAG,6BAA6B,CAAC,MAAM,IAAI,SAAS,CAAC,CAAC;QAEvD,OAAO;YACH,OAAO;gBACH,MAAM,IAAI,GAAG,eAAe,CAAC,OAAO,CAAC,CAAC;gBAEtC,IAAI,IAAI,KAAK,IAAI,EAAE,CAAC;oBAChB,OAAO;gBACX,CAAC;gBAED,KAAK,MAAM,GAAG,IAAI,eAAe,CAAC,IAAI,CAAC,EAAE,CAAC;oBACtC,MAAM,aAAa,GAAG,yBAAyB,CAC3C,GAAG,CAAC,OAAO,EACX,OAAO,CACV,CAAC;oBAEF,IAAI,aAAa,KAAK,IAAI,EAAE,CAAC;wBACzB,SAAS;oBACb,CAAC;oBAED,KAAK,MAAM,KAAK,IAAI,aAAa,CAAC,OAAO,EAAE,CAAC;wBACxC,MAAM,WAAW,GAAG,eAAe,CAAC,KAAK,CAAC,CAAC;wBAE3C,IAAI,WAAW,EAAE,IAAI,KAAK,aAAa,EAAE,CAAC;4BACtC,SAAS;wBACb,CAAC;wBAED,MAAM,QAAQ,GAAG,cAAc,CAAC,WAAW,EAAE,MAAM,CAAC,CAAC;wBACrD,MAAM,aAAa,GAAG,oBAAoB,CACtC,QAAQ,EAAE,KAAK,IAAI,IAAI,CAC1B,CAAC;wBAEF,IAAI,QAAQ,KAAK,IAAI,IAAI,aAAa,KAAK,IAAI,EAAE,CAAC;4BAC9C,SAAS;wBACb,CAAC;wBAED,IAAI,iBAAiB,CAAC,QAAQ,CAAC,aAAa,CAAC,EAAE,CAAC;4BAC5C,SAAS;wBACb,CAAC;wBAED,MAAM,eAAe,GACjB,sBAAsB,CAAC,aAAa,CAAC,CAAC;wBAE1C,IAAI,eAAe,CAAC,YAAY,EAAE,CAAC;4BAC/B,IAAI,CAAC,eAAe,EAAE,CAAC;gCACnB,OAAO,CAAC,MAAM,CAAC;oCACX,SAAS,EAAE,4BAA4B;oCACvC,IAAI,EAAE,CAAC,QAAQ,CAAC,KAAK;wCACjB,QAAQ,CAAyB;iCACxC,CAAC,CAAC;4BACP,CAAC;4BAED,SAAS;wBACb,CAAC;wBAED,IAAI,eAAe,CAAC,QAAQ,EAAE,CAAC;4BAC3B,IAAI,CAAC,WAAW,EAAE,CAAC;gCACf,OAAO,CAAC,MAAM,CAAC;oCACX,SAAS,EAAE,wBAAwB;oCACnC,IAAI,EAAE,CAAC,QAAQ,CAAC,KAAK;wCACjB,QAAQ,CAAyB;iCACxC,CAAC,CAAC;4BACP,CAAC;4BAED,SAAS;wBACb,CAAC;wBAED,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,eAAe,CAAC,KAAK,CAAC,EAAE,CAAC;4BACjD,OAAO,CAAC,MAAM,CAAC;gCACX,IAAI,EAAE;oCACF,KAAK,EAAE,eAAe,CAAC,KAAK;iCAC/B;gCACD,SAAS,EAAE,iBAAiB;gCAC5B,IAAI,EAAE,CAAC,QAAQ,CAAC,KAAK;oCACjB,QAAQ,CAAyB;6BACxC,CAAC,CAAC;wBACP,CAAC;oBACL,CAAC;gBACL,CAAC;YACL,CAAC;SACJ,CAAC;IACN,CAAC;IACD,IAAI,EAAE;QACF,cAAc,EAAE,CAAC,uBAAuB,CAAC;QACzC,IAAI,EAAE;YACF,OAAO,EAAE,CAAC,4BAA4B,CAAC;YACvC,WAAW,EACP,8DAA8D;YAClE,WAAW,EAAE,KAAK;YAClB,oBAAoB,EAAE,KAAK;YAC3B,MAAM,EAAE,MAAM;YACd,UAAU,EAAE,EAAE;YACd,GAAG,EAAE,+FAA+F;SACvG;QACD,QAAQ,EAAE;YACN,sBAAsB,EAClB,2EAA2E;YAC/E,0BAA0B,EACtB,+EAA+E;YACnF,eAAe,EACX,0FAA0F;SACjG;QACD,MAAM,EAAE;YACJ;gBACI,KAAK,EAAE;oBACH;wBACI,WAAW,EACP,wDAAwD;wBAC5D,IAAI,EAAE,UAAU;wBAChB,IAAI,EAAE,QAAQ;qBACjB;oBACD;wBACI,oBAAoB,EAAE,KAAK;wBAC3B,WAAW,EACP,iEAAiE;wBACrE,UAAU,EAAE;4BACR,WAAW,EAAE;gCACT,WAAW,EACP,yEAAyE;gCAC7E,IAAI,EAAE,SAAS;6BAClB;4BACD,eAAe,EAAE;gCACb,WAAW,EACP,8EAA8E;gCAClF,IAAI,EAAE,SAAS;6BAClB;4BACD,MAAM,EAAE;gCACJ,WAAW,EACP,8CAA8C;gCAClD,IAAI,EAAE,SAAS;6BAClB;4BACD,MAAM,EAAE;gCACJ,WAAW,EACP,wDAAwD;gCAC5D,IAAI,EAAE,SAAS;6BAClB;4BACD,OAAO,EAAE;gCACL,WAAW,EACP,qEAAqE;gCACzE,KAAK,EAAE;oCACH,IAAI,EAAE,QAAQ;iCACjB;gCACD,IAAI,EAAE,OAAO;gCACb,WAAW,EAAE,IAAI;6BACpB;4BACD,OAAO,EAAE;gCACL,WAAW,EACP,wDAAwD;gCAC5D,IAAI,EAAE,SAAS;6BAClB;yBACJ;wBACD,IAAI,EAAE,QAAQ;qBACjB;iBACJ;gBACD,WAAW,EACP,gEAAgE;aACvE;SACJ;QACD,IAAI,EAAE,YAAY;KACA;CACzB,CAAC;AAEF,eAAe,IAAI,CAAC"}
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @packageDocumentation
|
|
3
|
+
* Prefer `.yml` over `.yaml` for workflow template YAML files.
|
|
4
|
+
*/
|
|
5
|
+
import type { Rule } from "eslint";
|
|
6
|
+
/** Rule implementation for template YAML extension preference checks. */
|
|
7
|
+
declare const rule: Rule.RuleModule;
|
|
8
|
+
export default rule;
|
|
9
|
+
//# sourceMappingURL=prefer-template-yml-extension.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"prefer-template-yml-extension.d.ts","sourceRoot":"","sources":["../../src/rules/prefer-template-yml-extension.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAOnC,yEAAyE;AACzE,QAAA,MAAM,IAAI,EAAE,IAAI,CAAC,UAwChB,CAAC;AAEF,eAAe,IAAI,CAAC"}
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
import { isWorkflowTemplateYamlFile, usesYamlExtension, } from "../_internal/lint-targets.js";
|
|
2
|
+
/** Rule implementation for template YAML extension preference checks. */
|
|
3
|
+
const rule = {
|
|
4
|
+
create(context) {
|
|
5
|
+
return {
|
|
6
|
+
Program(node) {
|
|
7
|
+
if (!isWorkflowTemplateYamlFile(context.filename)) {
|
|
8
|
+
return;
|
|
9
|
+
}
|
|
10
|
+
if (!usesYamlExtension(context.filename)) {
|
|
11
|
+
return;
|
|
12
|
+
}
|
|
13
|
+
context.report({
|
|
14
|
+
messageId: "preferTemplateYml",
|
|
15
|
+
node: node,
|
|
16
|
+
});
|
|
17
|
+
},
|
|
18
|
+
};
|
|
19
|
+
},
|
|
20
|
+
meta: {
|
|
21
|
+
docs: {
|
|
22
|
+
configs: [
|
|
23
|
+
"github-actions.configs.workflowTemplates",
|
|
24
|
+
"github-actions.configs.all",
|
|
25
|
+
],
|
|
26
|
+
description: "require workflow template files to prefer `.yml` over `.yaml`.",
|
|
27
|
+
recommended: true,
|
|
28
|
+
requiresTypeChecking: false,
|
|
29
|
+
ruleId: "R066",
|
|
30
|
+
ruleNumber: 66,
|
|
31
|
+
url: "https://nick2bad4u.github.io/eslint-plugin-github-actions-2/docs/rules/prefer-template-yml-extension",
|
|
32
|
+
},
|
|
33
|
+
messages: {
|
|
34
|
+
preferTemplateYml: "Prefer `.yml` for workflow template files instead of `.yaml`.",
|
|
35
|
+
},
|
|
36
|
+
schema: [],
|
|
37
|
+
type: "suggestion",
|
|
38
|
+
},
|
|
39
|
+
};
|
|
40
|
+
export default rule;
|
|
41
|
+
//# sourceMappingURL=prefer-template-yml-extension.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"prefer-template-yml-extension.js","sourceRoot":"","sources":["../../src/rules/prefer-template-yml-extension.ts"],"names":[],"mappings":"AAMA,OAAO,EACH,0BAA0B,EAC1B,iBAAiB,GACpB,MAAM,8BAA8B,CAAC;AAEtC,yEAAyE;AACzE,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,IAAI,CAAC,iBAAiB,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC;oBACvC,OAAO;gBACX,CAAC;gBAED,OAAO,CAAC,MAAM,CAAC;oBACX,SAAS,EAAE,mBAAmB;oBAC9B,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,gEAAgE;YACpE,WAAW,EAAE,IAAI;YACjB,oBAAoB,EAAE,KAAK;YAC3B,MAAM,EAAE,MAAM;YACd,UAAU,EAAE,EAAE;YACd,GAAG,EAAE,sGAAsG;SAC9G;QACD,QAAQ,EAAE;YACN,iBAAiB,EACb,+DAA+D;SACtE;QACD,MAAM,EAAE,EAAE;QACV,IAAI,EAAE,YAAY;KACA;CACzB,CAAC;AAEF,eAAe,IAAI,CAAC"}
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @packageDocumentation
|
|
3
|
+
* Require every workflow file to declare a human-readable top-level name.
|
|
4
|
+
*/
|
|
5
|
+
import type { Rule } from "eslint";
|
|
6
|
+
/** Rule implementation for requiring a string workflow name. */
|
|
7
|
+
declare const rule: Rule.RuleModule;
|
|
8
|
+
export default rule;
|
|
9
|
+
//# sourceMappingURL=require-action-name.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"require-action-name.d.ts","sourceRoot":"","sources":["../../src/rules/require-action-name.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAQnC,gEAAgE;AAChE,QAAA,MAAM,IAAI,EAAE,IAAI,CAAC,UA6DhB,CAAC;AAEF,eAAe,IAAI,CAAC"}
|
|
@@ -0,0 +1,57 @@
|
|
|
1
|
+
import { getMappingPair, getScalarStringValue, getWorkflowRoot, } from "../_internal/workflow-yaml.js";
|
|
2
|
+
/** Rule implementation for requiring a string workflow name. */
|
|
3
|
+
const rule = {
|
|
4
|
+
create(context) {
|
|
5
|
+
return {
|
|
6
|
+
Program(node) {
|
|
7
|
+
const root = getWorkflowRoot(context);
|
|
8
|
+
if (root === null) {
|
|
9
|
+
context.report({
|
|
10
|
+
messageId: "missingName",
|
|
11
|
+
node: node,
|
|
12
|
+
});
|
|
13
|
+
return;
|
|
14
|
+
}
|
|
15
|
+
const namePair = getMappingPair(root, "name");
|
|
16
|
+
if (namePair === null) {
|
|
17
|
+
context.report({
|
|
18
|
+
messageId: "missingName",
|
|
19
|
+
node: root,
|
|
20
|
+
});
|
|
21
|
+
return;
|
|
22
|
+
}
|
|
23
|
+
const nameValue = getScalarStringValue(namePair.value);
|
|
24
|
+
if (nameValue === null || nameValue.trim().length === 0) {
|
|
25
|
+
context.report({
|
|
26
|
+
messageId: "invalidName",
|
|
27
|
+
node: (namePair.value ??
|
|
28
|
+
namePair),
|
|
29
|
+
});
|
|
30
|
+
}
|
|
31
|
+
},
|
|
32
|
+
};
|
|
33
|
+
},
|
|
34
|
+
meta: {
|
|
35
|
+
docs: {
|
|
36
|
+
configs: [
|
|
37
|
+
"github-actions.configs.all",
|
|
38
|
+
"github-actions.configs.recommended",
|
|
39
|
+
"github-actions.configs.strict",
|
|
40
|
+
],
|
|
41
|
+
description: "require a non-empty string workflow `name` so workflow runs stay readable in the GitHub Actions UI.",
|
|
42
|
+
recommended: true,
|
|
43
|
+
requiresTypeChecking: false,
|
|
44
|
+
ruleId: "R005",
|
|
45
|
+
ruleNumber: 5,
|
|
46
|
+
url: "https://nick2bad4u.github.io/eslint-plugin-github-actions-2/docs/rules/require-action-name",
|
|
47
|
+
},
|
|
48
|
+
messages: {
|
|
49
|
+
invalidName: "Workflow `name` must be a non-empty string.",
|
|
50
|
+
missingName: "Add a top-level workflow `name` so runs are identifiable in the GitHub Actions UI.",
|
|
51
|
+
},
|
|
52
|
+
schema: [],
|
|
53
|
+
type: "suggestion",
|
|
54
|
+
},
|
|
55
|
+
};
|
|
56
|
+
export default rule;
|
|
57
|
+
//# sourceMappingURL=require-action-name.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"require-action-name.js","sourceRoot":"","sources":["../../src/rules/require-action-name.ts"],"names":[],"mappings":"AAMA,OAAO,EACH,cAAc,EACd,oBAAoB,EACpB,eAAe,GAClB,MAAM,+BAA+B,CAAC;AAEvC,gEAAgE;AAChE,MAAM,IAAI,GAAoB;IAC1B,MAAM,CAAC,OAAO;QACV,OAAO;YACH,OAAO,CAAC,IAAI;gBACR,MAAM,IAAI,GAAG,eAAe,CAAC,OAAO,CAAC,CAAC;gBAEtC,IAAI,IAAI,KAAK,IAAI,EAAE,CAAC;oBAChB,OAAO,CAAC,MAAM,CAAC;wBACX,SAAS,EAAE,aAAa;wBACxB,IAAI,EAAE,IAA4B;qBACrC,CAAC,CAAC;oBAEH,OAAO;gBACX,CAAC;gBAED,MAAM,QAAQ,GAAG,cAAc,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;gBAE9C,IAAI,QAAQ,KAAK,IAAI,EAAE,CAAC;oBACpB,OAAO,CAAC,MAAM,CAAC;wBACX,SAAS,EAAE,aAAa;wBACxB,IAAI,EAAE,IAA4B;qBACrC,CAAC,CAAC;oBAEH,OAAO;gBACX,CAAC;gBAED,MAAM,SAAS,GAAG,oBAAoB,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;gBAEvD,IAAI,SAAS,KAAK,IAAI,IAAI,SAAS,CAAC,IAAI,EAAE,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;oBACtD,OAAO,CAAC,MAAM,CAAC;wBACX,SAAS,EAAE,aAAa;wBACxB,IAAI,EAAE,CAAC,QAAQ,CAAC,KAAK;4BACjB,QAAQ,CAAyB;qBACxC,CAAC,CAAC;gBACP,CAAC;YACL,CAAC;SACJ,CAAC;IACN,CAAC;IACD,IAAI,EAAE;QACF,IAAI,EAAE;YACF,OAAO,EAAE;gBACL,4BAA4B;gBAC5B,oCAAoC;gBACpC,+BAA+B;aAClC;YACD,WAAW,EACP,qGAAqG;YACzG,WAAW,EAAE,IAAI;YACjB,oBAAoB,EAAE,KAAK;YAC3B,MAAM,EAAE,MAAM;YACd,UAAU,EAAE,CAAC;YACb,GAAG,EAAE,4FAA4F;SACpG;QACD,QAAQ,EAAE;YACN,WAAW,EAAE,6CAA6C;YAC1D,WAAW,EACP,oFAAoF;SAC3F;QACD,MAAM,EAAE,EAAE;QACV,IAAI,EAAE,YAAY;KACA;CACzB,CAAC;AAEF,eAAe,IAAI,CAAC"}
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @packageDocumentation
|
|
3
|
+
* Require every workflow file to declare a run-name string.
|
|
4
|
+
*/
|
|
5
|
+
import type { Rule } from "eslint";
|
|
6
|
+
/** Rule implementation for requiring a string workflow run-name. */
|
|
7
|
+
declare const rule: Rule.RuleModule;
|
|
8
|
+
export default rule;
|
|
9
|
+
//# sourceMappingURL=require-action-run-name.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"require-action-run-name.d.ts","sourceRoot":"","sources":["../../src/rules/require-action-run-name.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAQnC,oEAAoE;AACpE,QAAA,MAAM,IAAI,EAAE,IAAI,CAAC,UA4DhB,CAAC;AAEF,eAAe,IAAI,CAAC"}
|
|
@@ -0,0 +1,56 @@
|
|
|
1
|
+
import { getMappingPair, getScalarStringValue, getWorkflowRoot, } from "../_internal/workflow-yaml.js";
|
|
2
|
+
/** Rule implementation for requiring a string workflow run-name. */
|
|
3
|
+
const rule = {
|
|
4
|
+
create(context) {
|
|
5
|
+
return {
|
|
6
|
+
Program(node) {
|
|
7
|
+
const root = getWorkflowRoot(context);
|
|
8
|
+
if (root === null) {
|
|
9
|
+
context.report({
|
|
10
|
+
messageId: "missingRunName",
|
|
11
|
+
node: node,
|
|
12
|
+
});
|
|
13
|
+
return;
|
|
14
|
+
}
|
|
15
|
+
const runNamePair = getMappingPair(root, "run-name");
|
|
16
|
+
if (runNamePair === null) {
|
|
17
|
+
context.report({
|
|
18
|
+
messageId: "missingRunName",
|
|
19
|
+
node: root,
|
|
20
|
+
});
|
|
21
|
+
return;
|
|
22
|
+
}
|
|
23
|
+
const runNameValue = getScalarStringValue(runNamePair.value);
|
|
24
|
+
if (runNameValue === null || runNameValue.trim().length === 0) {
|
|
25
|
+
context.report({
|
|
26
|
+
messageId: "invalidRunName",
|
|
27
|
+
node: (runNamePair.value ??
|
|
28
|
+
runNamePair),
|
|
29
|
+
});
|
|
30
|
+
}
|
|
31
|
+
},
|
|
32
|
+
};
|
|
33
|
+
},
|
|
34
|
+
meta: {
|
|
35
|
+
docs: {
|
|
36
|
+
configs: [
|
|
37
|
+
"github-actions.configs.all",
|
|
38
|
+
"github-actions.configs.strict",
|
|
39
|
+
],
|
|
40
|
+
description: "require a non-empty string workflow `run-name` when you want queued and in-progress runs to remain self-describing.",
|
|
41
|
+
recommended: false,
|
|
42
|
+
requiresTypeChecking: false,
|
|
43
|
+
ruleId: "R006",
|
|
44
|
+
ruleNumber: 6,
|
|
45
|
+
url: "https://nick2bad4u.github.io/eslint-plugin-github-actions-2/docs/rules/require-action-run-name",
|
|
46
|
+
},
|
|
47
|
+
messages: {
|
|
48
|
+
invalidRunName: "Workflow `run-name` must be a non-empty string.",
|
|
49
|
+
missingRunName: "Add a top-level workflow `run-name` so individual workflow runs are easier to distinguish.",
|
|
50
|
+
},
|
|
51
|
+
schema: [],
|
|
52
|
+
type: "suggestion",
|
|
53
|
+
},
|
|
54
|
+
};
|
|
55
|
+
export default rule;
|
|
56
|
+
//# sourceMappingURL=require-action-run-name.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"require-action-run-name.js","sourceRoot":"","sources":["../../src/rules/require-action-run-name.ts"],"names":[],"mappings":"AAMA,OAAO,EACH,cAAc,EACd,oBAAoB,EACpB,eAAe,GAClB,MAAM,+BAA+B,CAAC;AAEvC,oEAAoE;AACpE,MAAM,IAAI,GAAoB;IAC1B,MAAM,CAAC,OAAO;QACV,OAAO;YACH,OAAO,CAAC,IAAI;gBACR,MAAM,IAAI,GAAG,eAAe,CAAC,OAAO,CAAC,CAAC;gBAEtC,IAAI,IAAI,KAAK,IAAI,EAAE,CAAC;oBAChB,OAAO,CAAC,MAAM,CAAC;wBACX,SAAS,EAAE,gBAAgB;wBAC3B,IAAI,EAAE,IAA4B;qBACrC,CAAC,CAAC;oBAEH,OAAO;gBACX,CAAC;gBAED,MAAM,WAAW,GAAG,cAAc,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;gBAErD,IAAI,WAAW,KAAK,IAAI,EAAE,CAAC;oBACvB,OAAO,CAAC,MAAM,CAAC;wBACX,SAAS,EAAE,gBAAgB;wBAC3B,IAAI,EAAE,IAA4B;qBACrC,CAAC,CAAC;oBAEH,OAAO;gBACX,CAAC;gBAED,MAAM,YAAY,GAAG,oBAAoB,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;gBAE7D,IAAI,YAAY,KAAK,IAAI,IAAI,YAAY,CAAC,IAAI,EAAE,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;oBAC5D,OAAO,CAAC,MAAM,CAAC;wBACX,SAAS,EAAE,gBAAgB;wBAC3B,IAAI,EAAE,CAAC,WAAW,CAAC,KAAK;4BACpB,WAAW,CAAyB;qBAC3C,CAAC,CAAC;gBACP,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,qHAAqH;YACzH,WAAW,EAAE,KAAK;YAClB,oBAAoB,EAAE,KAAK;YAC3B,MAAM,EAAE,MAAM;YACd,UAAU,EAAE,CAAC;YACb,GAAG,EAAE,gGAAgG;SACxG;QACD,QAAQ,EAAE;YACN,cAAc,EAAE,iDAAiD;YACjE,cAAc,EACV,4FAA4F;SACnG;QACD,MAAM,EAAE,EAAE;QACV,IAAI,EAAE,YAAY;KACA;CACzB,CAAC;AAEF,eAAe,IAAI,CAAC"}
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @packageDocumentation
|
|
3
|
+
* Require a checkout step before using repository-local actions.
|
|
4
|
+
*/
|
|
5
|
+
import type { Rule } from "eslint";
|
|
6
|
+
/** Rule implementation for requiring checkout before local actions. */
|
|
7
|
+
declare const rule: Rule.RuleModule;
|
|
8
|
+
export default rule;
|
|
9
|
+
//# sourceMappingURL=require-checkout-before-local-action.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"require-checkout-before-local-action.d.ts","sourceRoot":"","sources":["../../src/rules/require-checkout-before-local-action.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAmBnC,uEAAuE;AACvE,QAAA,MAAM,IAAI,EAAE,IAAI,CAAC,UAoFhB,CAAC;AAEF,eAAe,IAAI,CAAC"}
|
|
@@ -0,0 +1,74 @@
|
|
|
1
|
+
import { getMappingPair, getMappingValueAsSequence, getScalarStringValue, getWorkflowJobs, getWorkflowRoot, unwrapYamlValue, } from "../_internal/workflow-yaml.js";
|
|
2
|
+
/** Determine whether a step uses the checkout action. */
|
|
3
|
+
const isCheckoutActionReference = (reference) => reference.startsWith("actions/checkout@");
|
|
4
|
+
/** Determine whether a step uses a repository-local action path. */
|
|
5
|
+
const isLocalActionReference = (reference) => reference.startsWith("./");
|
|
6
|
+
/** Rule implementation for requiring checkout before local actions. */
|
|
7
|
+
const rule = {
|
|
8
|
+
create(context) {
|
|
9
|
+
return {
|
|
10
|
+
Program() {
|
|
11
|
+
const root = getWorkflowRoot(context);
|
|
12
|
+
if (root === null) {
|
|
13
|
+
return;
|
|
14
|
+
}
|
|
15
|
+
for (const job of getWorkflowJobs(root)) {
|
|
16
|
+
const stepsSequence = getMappingValueAsSequence(job.mapping, "steps");
|
|
17
|
+
if (stepsSequence === null) {
|
|
18
|
+
continue;
|
|
19
|
+
}
|
|
20
|
+
let hasSeenCheckout = false;
|
|
21
|
+
for (const entry of stepsSequence.entries) {
|
|
22
|
+
const stepMapping = unwrapYamlValue(entry);
|
|
23
|
+
if (stepMapping?.type !== "YAMLMapping") {
|
|
24
|
+
continue;
|
|
25
|
+
}
|
|
26
|
+
const usesPair = getMappingPair(stepMapping, "uses");
|
|
27
|
+
const usesReference = getScalarStringValue(usesPair?.value ?? null);
|
|
28
|
+
if (usesPair === null || usesReference === null) {
|
|
29
|
+
continue;
|
|
30
|
+
}
|
|
31
|
+
if (isCheckoutActionReference(usesReference)) {
|
|
32
|
+
hasSeenCheckout = true;
|
|
33
|
+
continue;
|
|
34
|
+
}
|
|
35
|
+
if (isLocalActionReference(usesReference) &&
|
|
36
|
+
!hasSeenCheckout) {
|
|
37
|
+
context.report({
|
|
38
|
+
data: {
|
|
39
|
+
jobId: job.id,
|
|
40
|
+
reference: usesReference,
|
|
41
|
+
},
|
|
42
|
+
messageId: "missingCheckoutBeforeLocalAction",
|
|
43
|
+
node: (usesPair.value ??
|
|
44
|
+
usesPair),
|
|
45
|
+
});
|
|
46
|
+
}
|
|
47
|
+
}
|
|
48
|
+
}
|
|
49
|
+
},
|
|
50
|
+
};
|
|
51
|
+
},
|
|
52
|
+
meta: {
|
|
53
|
+
docs: {
|
|
54
|
+
configs: [
|
|
55
|
+
"github-actions.configs.all",
|
|
56
|
+
"github-actions.configs.recommended",
|
|
57
|
+
"github-actions.configs.strict",
|
|
58
|
+
],
|
|
59
|
+
description: "require an `actions/checkout` step before using repository-local step actions so local action paths resolve reliably.",
|
|
60
|
+
recommended: true,
|
|
61
|
+
requiresTypeChecking: false,
|
|
62
|
+
ruleId: "R025",
|
|
63
|
+
ruleNumber: 25,
|
|
64
|
+
url: "https://nick2bad4u.github.io/eslint-plugin-github-actions-2/docs/rules/require-checkout-before-local-action",
|
|
65
|
+
},
|
|
66
|
+
messages: {
|
|
67
|
+
missingCheckoutBeforeLocalAction: "Job '{{jobId}}' uses local action '{{reference}}' before any `actions/checkout` step. Check out the repository first.",
|
|
68
|
+
},
|
|
69
|
+
schema: [],
|
|
70
|
+
type: "problem",
|
|
71
|
+
},
|
|
72
|
+
};
|
|
73
|
+
export default rule;
|
|
74
|
+
//# sourceMappingURL=require-checkout-before-local-action.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"require-checkout-before-local-action.js","sourceRoot":"","sources":["../../src/rules/require-checkout-before-local-action.ts"],"names":[],"mappings":"AAMA,OAAO,EACH,cAAc,EACd,yBAAyB,EACzB,oBAAoB,EACpB,eAAe,EACf,eAAe,EACf,eAAe,GAClB,MAAM,+BAA+B,CAAC;AAEvC,yDAAyD;AACzD,MAAM,yBAAyB,GAAG,CAAC,SAAiB,EAAW,EAAE,CAC7D,SAAS,CAAC,UAAU,CAAC,mBAAmB,CAAC,CAAC;AAE9C,oEAAoE;AACpE,MAAM,sBAAsB,GAAG,CAAC,SAAiB,EAAW,EAAE,CAC1D,SAAS,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;AAE/B,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,KAAK,MAAM,GAAG,IAAI,eAAe,CAAC,IAAI,CAAC,EAAE,CAAC;oBACtC,MAAM,aAAa,GAAG,yBAAyB,CAC3C,GAAG,CAAC,OAAO,EACX,OAAO,CACV,CAAC;oBAEF,IAAI,aAAa,KAAK,IAAI,EAAE,CAAC;wBACzB,SAAS;oBACb,CAAC;oBAED,IAAI,eAAe,GAAG,KAAK,CAAC;oBAE5B,KAAK,MAAM,KAAK,IAAI,aAAa,CAAC,OAAO,EAAE,CAAC;wBACxC,MAAM,WAAW,GAAG,eAAe,CAAC,KAAK,CAAC,CAAC;wBAE3C,IAAI,WAAW,EAAE,IAAI,KAAK,aAAa,EAAE,CAAC;4BACtC,SAAS;wBACb,CAAC;wBAED,MAAM,QAAQ,GAAG,cAAc,CAAC,WAAW,EAAE,MAAM,CAAC,CAAC;wBACrD,MAAM,aAAa,GAAG,oBAAoB,CACtC,QAAQ,EAAE,KAAK,IAAI,IAAI,CAC1B,CAAC;wBAEF,IAAI,QAAQ,KAAK,IAAI,IAAI,aAAa,KAAK,IAAI,EAAE,CAAC;4BAC9C,SAAS;wBACb,CAAC;wBAED,IAAI,yBAAyB,CAAC,aAAa,CAAC,EAAE,CAAC;4BAC3C,eAAe,GAAG,IAAI,CAAC;4BACvB,SAAS;wBACb,CAAC;wBAED,IACI,sBAAsB,CAAC,aAAa,CAAC;4BACrC,CAAC,eAAe,EAClB,CAAC;4BACC,OAAO,CAAC,MAAM,CAAC;gCACX,IAAI,EAAE;oCACF,KAAK,EAAE,GAAG,CAAC,EAAE;oCACb,SAAS,EAAE,aAAa;iCAC3B;gCACD,SAAS,EAAE,kCAAkC;gCAC7C,IAAI,EAAE,CAAC,QAAQ,CAAC,KAAK;oCACjB,QAAQ,CAAyB;6BACxC,CAAC,CAAC;wBACP,CAAC;oBACL,CAAC;gBACL,CAAC;YACL,CAAC;SACJ,CAAC;IACN,CAAC;IACD,IAAI,EAAE;QACF,IAAI,EAAE;YACF,OAAO,EAAE;gBACL,4BAA4B;gBAC5B,oCAAoC;gBACpC,+BAA+B;aAClC;YACD,WAAW,EACP,uHAAuH;YAC3H,WAAW,EAAE,IAAI;YACjB,oBAAoB,EAAE,KAAK;YAC3B,MAAM,EAAE,MAAM;YACd,UAAU,EAAE,EAAE;YACd,GAAG,EAAE,6GAA6G;SACrH;QACD,QAAQ,EAAE;YACN,gCAAgC,EAC5B,uHAAuH;SAC9H;QACD,MAAM,EAAE,EAAE;QACV,IAAI,EAAE,SAAS;KACG;CACzB,CAAC;AAEF,eAAe,IAAI,CAAC"}
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @packageDocumentation
|
|
3
|
+
* Require `name` on composite action steps.
|
|
4
|
+
*/
|
|
5
|
+
import type { Rule } from "eslint";
|
|
6
|
+
/** Rule implementation for requiring names on composite steps. */
|
|
7
|
+
declare const rule: Rule.RuleModule;
|
|
8
|
+
export default rule;
|
|
9
|
+
//# sourceMappingURL=require-composite-step-name.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"require-composite-step-name.d.ts","sourceRoot":"","sources":["../../src/rules/require-composite-step-name.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAYnC,kEAAkE;AAClE,QAAA,MAAM,IAAI,EAAE,IAAI,CAAC,UAqFhB,CAAC;AAEF,eAAe,IAAI,CAAC"}
|
|
@@ -0,0 +1,67 @@
|
|
|
1
|
+
import { isActionMetadataFile } from "../_internal/lint-targets.js";
|
|
2
|
+
import { getMappingPair, getMappingValueAsMapping, getMappingValueAsSequence, getScalarStringValue, getWorkflowRoot, unwrapYamlValue, } from "../_internal/workflow-yaml.js";
|
|
3
|
+
/** Rule implementation for requiring names on composite steps. */
|
|
4
|
+
const rule = {
|
|
5
|
+
create(context) {
|
|
6
|
+
return {
|
|
7
|
+
Program() {
|
|
8
|
+
if (!isActionMetadataFile(context.filename)) {
|
|
9
|
+
return;
|
|
10
|
+
}
|
|
11
|
+
const root = getWorkflowRoot(context);
|
|
12
|
+
const runsMapping = root === null
|
|
13
|
+
? null
|
|
14
|
+
: getMappingValueAsMapping(root, "runs");
|
|
15
|
+
if (runsMapping === null) {
|
|
16
|
+
return;
|
|
17
|
+
}
|
|
18
|
+
const usingRuntime = getScalarStringValue(getMappingPair(runsMapping, "using")?.value);
|
|
19
|
+
if (usingRuntime !== "composite") {
|
|
20
|
+
return;
|
|
21
|
+
}
|
|
22
|
+
const stepsSequence = getMappingValueAsSequence(runsMapping, "steps");
|
|
23
|
+
if (stepsSequence === null) {
|
|
24
|
+
return;
|
|
25
|
+
}
|
|
26
|
+
for (const [index, stepEntry,] of stepsSequence.entries.entries()) {
|
|
27
|
+
const stepMapping = unwrapYamlValue(stepEntry);
|
|
28
|
+
if (stepMapping?.type !== "YAMLMapping") {
|
|
29
|
+
continue;
|
|
30
|
+
}
|
|
31
|
+
const nameValue = getScalarStringValue(getMappingPair(stepMapping, "name")?.value);
|
|
32
|
+
if (nameValue !== null && nameValue.trim().length > 0) {
|
|
33
|
+
continue;
|
|
34
|
+
}
|
|
35
|
+
context.report({
|
|
36
|
+
data: {
|
|
37
|
+
index: String(index + 1),
|
|
38
|
+
},
|
|
39
|
+
messageId: "missingCompositeStepName",
|
|
40
|
+
node: stepMapping,
|
|
41
|
+
});
|
|
42
|
+
}
|
|
43
|
+
},
|
|
44
|
+
};
|
|
45
|
+
},
|
|
46
|
+
meta: {
|
|
47
|
+
docs: {
|
|
48
|
+
configs: [
|
|
49
|
+
"github-actions.configs.actionMetadata",
|
|
50
|
+
"github-actions.configs.all",
|
|
51
|
+
],
|
|
52
|
+
description: "require each composite action step to declare a descriptive `name`.",
|
|
53
|
+
recommended: false,
|
|
54
|
+
requiresTypeChecking: false,
|
|
55
|
+
ruleId: "R052",
|
|
56
|
+
ruleNumber: 52,
|
|
57
|
+
url: "https://nick2bad4u.github.io/eslint-plugin-github-actions-2/docs/rules/require-composite-step-name",
|
|
58
|
+
},
|
|
59
|
+
messages: {
|
|
60
|
+
missingCompositeStepName: "Composite step #{{index}} should declare a non-empty `name` for readability and debugging.",
|
|
61
|
+
},
|
|
62
|
+
schema: [],
|
|
63
|
+
type: "suggestion",
|
|
64
|
+
},
|
|
65
|
+
};
|
|
66
|
+
export default rule;
|
|
67
|
+
//# sourceMappingURL=require-composite-step-name.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"require-composite-step-name.js","sourceRoot":"","sources":["../../src/rules/require-composite-step-name.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,oBAAoB,EAAE,MAAM,8BAA8B,CAAC;AACpE,OAAO,EACH,cAAc,EACd,wBAAwB,EACxB,yBAAyB,EACzB,oBAAoB,EACpB,eAAe,EACf,eAAe,GAClB,MAAM,+BAA+B,CAAC;AAEvC,kEAAkE;AAClE,MAAM,IAAI,GAAoB;IAC1B,MAAM,CAAC,OAAO;QACV,OAAO;YACH,OAAO;gBACH,IAAI,CAAC,oBAAoB,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC;oBAC1C,OAAO;gBACX,CAAC;gBAED,MAAM,IAAI,GAAG,eAAe,CAAC,OAAO,CAAC,CAAC;gBACtC,MAAM,WAAW,GACb,IAAI,KAAK,IAAI;oBACT,CAAC,CAAC,IAAI;oBACN,CAAC,CAAC,wBAAwB,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;gBAEjD,IAAI,WAAW,KAAK,IAAI,EAAE,CAAC;oBACvB,OAAO;gBACX,CAAC;gBAED,MAAM,YAAY,GAAG,oBAAoB,CACrC,cAAc,CAAC,WAAW,EAAE,OAAO,CAAC,EAAE,KAAK,CAC9C,CAAC;gBAEF,IAAI,YAAY,KAAK,WAAW,EAAE,CAAC;oBAC/B,OAAO;gBACX,CAAC;gBAED,MAAM,aAAa,GAAG,yBAAyB,CAC3C,WAAW,EACX,OAAO,CACV,CAAC;gBAEF,IAAI,aAAa,KAAK,IAAI,EAAE,CAAC;oBACzB,OAAO;gBACX,CAAC;gBAED,KAAK,MAAM,CACP,KAAK,EACL,SAAS,EACZ,IAAI,aAAa,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC;oBACnC,MAAM,WAAW,GAAG,eAAe,CAAC,SAAS,CAAC,CAAC;oBAE/C,IAAI,WAAW,EAAE,IAAI,KAAK,aAAa,EAAE,CAAC;wBACtC,SAAS;oBACb,CAAC;oBAED,MAAM,SAAS,GAAG,oBAAoB,CAClC,cAAc,CAAC,WAAW,EAAE,MAAM,CAAC,EAAE,KAAK,CAC7C,CAAC;oBAEF,IAAI,SAAS,KAAK,IAAI,IAAI,SAAS,CAAC,IAAI,EAAE,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;wBACpD,SAAS;oBACb,CAAC;oBAED,OAAO,CAAC,MAAM,CAAC;wBACX,IAAI,EAAE;4BACF,KAAK,EAAE,MAAM,CAAC,KAAK,GAAG,CAAC,CAAC;yBAC3B;wBACD,SAAS,EAAE,0BAA0B;wBACrC,IAAI,EAAE,WAAmC;qBAC5C,CAAC,CAAC;gBACP,CAAC;YACL,CAAC;SACJ,CAAC;IACN,CAAC;IACD,IAAI,EAAE;QACF,IAAI,EAAE;YACF,OAAO,EAAE;gBACL,uCAAuC;gBACvC,4BAA4B;aAC/B;YACD,WAAW,EACP,qEAAqE;YACzE,WAAW,EAAE,KAAK;YAClB,oBAAoB,EAAE,KAAK;YAC3B,MAAM,EAAE,MAAM;YACd,UAAU,EAAE,EAAE;YACd,GAAG,EAAE,oGAAoG;SAC5G;QACD,QAAQ,EAAE;YACN,wBAAwB,EACpB,4FAA4F;SACnG;QACD,MAAM,EAAE,EAAE;QACV,IAAI,EAAE,YAAY;KACA;CACzB,CAAC;AAEF,eAAe,IAAI,CAAC"}
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @packageDocumentation
|
|
3
|
+
* Require every GitHub Actions job to declare a string name.
|
|
4
|
+
*/
|
|
5
|
+
import type { Rule } from "eslint";
|
|
6
|
+
/** Rule implementation for requiring explicit job names. */
|
|
7
|
+
declare const rule: Rule.RuleModule;
|
|
8
|
+
export default rule;
|
|
9
|
+
//# sourceMappingURL=require-job-name.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"require-job-name.d.ts","sourceRoot":"","sources":["../../src/rules/require-job-name.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAWnC,4DAA4D;AAC5D,QAAA,MAAM,IAAI,EAAE,IAAI,CAAC,UA+EhB,CAAC;AAEF,eAAe,IAAI,CAAC"}
|