feature: ignore unsupported YAML files #6
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This adds logic to ignore unsupported YAML files (non-GitHub Workflows, and non-GitHub Composite Actions YAML files). This new logic is also enabled by default. It makes it easier to work with `shellcheck-gha` as `.github/` directory may contains multiple kinds of YAML files such as `dependabot.yaml`. Before this change it would require to make sure there are no unrelated YAML files in the `.github/` directory which is inconvenient and makes the tool hard to use.
NyanKiyoshi
added a commit
that referenced
this pull request
Apr 16, 2024
Following #6, this PR changes the default scan directory from `./.github/workflows` to `./.github` as it allows to gather all composite actions which are usually contained under `./.github/actions/`. This thus ensures that by default, `shellcheck-gha` will be scanning both composite actions and GitHub workflows. But it is also important to keep in mind that composite actions can live outside `./.github/` thus may require users to tweak configurations.
fowczarek
previously approved these changes
Apr 17, 2024
NyanKiyoshi
commented
Apr 17, 2024
fowczarek
approved these changes
Apr 17, 2024
korycins
approved these changes
Apr 19, 2024
NyanKiyoshi
added a commit
that referenced
this pull request
Apr 19, 2024
Following #6, this PR changes the default scan directory from `./.github/workflows` to `./.github` as it allows to gather all composite actions which are usually contained under `./.github/actions/`. This thus ensures that by default, `shellcheck-gha` will be scanning both composite actions and GitHub workflows. But it is also important to keep in mind that composite actions can live outside `./.github/` thus may require users to tweak configurations.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This adds logic to ignore unsupported YAML files (non-GitHub Workflows, and non-GitHub Composite Actions YAML files). This new logic is also enabled by default.
It makes it easier to work with
shellcheck-ghaas.github/directory may contains multiple kinds of YAML files such asdependabot.yaml. Before this change it would require to make sure there are no unrelated YAML files in the.github/directory which is inconvenient and makes the tool hard to use.