Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

README: suggest use of line folding #82

Merged
merged 3 commits into from
Jan 28, 2023
Merged

README: suggest use of line folding #82

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
41eafd7
README: suggest use of line folding
Cireo Jan 2, 2023
3bc2791
README: line break extended line
Cireo Jan 15, 2023
8f9f0b7
Update README.md
ludeeus Jan 28, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ example:

## Ignore paths and names

You can use the `ignore_paths` and `ignore_names` input to disable specific directories and files.
You can use the `ignore_paths` and `ignore_names` input to disable specific directories and files. These are passed as environment variables, and should evaluate to a single space separated string. It may be convenient to use [`>-`](https://yaml.org/spec/1.2.2/#65-line-folding) for readability if you have multiple selectors.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
You can use the `ignore_paths` and `ignore_names` input to disable specific directories and files. These are passed as environment variables, and should evaluate to a single space separated string. It may be convenient to use [`>-`](https://yaml.org/spec/1.2.2/#65-line-folding) for readability if you have multiple selectors.
You can use the `ignore_paths` and `ignore_names` input to disable specific directories and files.
These are passed as environment variables, and should evaluate to a single space separated string.
It may be convenient to use [`>-`](https://yaml.org/spec/1.2.2/#65-line-folding) for readability if you have multiple selectors.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure, incorporated.


```text
sample structure:
Expand All @@ -61,7 +61,9 @@ example:
- name: Run ShellCheck
uses: ludeeus/action-shellcheck@master
with:
ignore_paths: ignoreme ignoremetoo
ignore_paths: >-
ignoreme
ignoremetoo
ignore_names: ignorable.sh
```

Expand Down Expand Up @@ -174,5 +176,5 @@ If running the latest stable version of Shellcheck is not to your liking, you ca
- name: Run ShellCheck
uses: ludeeus/action-shellcheck@master
with:
version: v0.7.0
version: v0.9.0
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Neither of those versions seem available as github releases

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How about 1.0.0?
since v1.1.0 is latest, that would be the next viable candidate

Copy link
Contributor Author

@Cireo Cireo Jan 15, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I chose this per the README

When specifying a custom version, please use any of the released versions listed in the Shellcheck repository.

The version is presumably for shellcheck, not for action-shellcheck

Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is indeed for the binary, but its also not related to this.

ludeeus marked this conversation as resolved.
Show resolved Hide resolved
```