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.

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

README: suggest use of line folding #82

Merged
merged 3 commits into from
Jan 28, 2023
Merged

Conversation

Cireo
Copy link
Contributor

@Cireo Cireo commented Jan 2, 2023

The >- operator is convenient and quickly becomes more readable.

The `>-` operator is convenient and quickly becomes more readable.
Copy link

@port19x port19x left a comment

Choose a reason for hiding this comment

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

Looks good overall

README.md Outdated
@@ -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.

README.md Outdated
Comment on lines 177 to 179
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

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.

@Cireo
Copy link
Contributor Author

Cireo commented Jan 15, 2023

Note the checks won't run without someone poking them

Screen Shot 2023-01-15 at 11 01 00 AM

README.md Outdated Show resolved Hide resolved
README.md Outdated
Comment on lines 177 to 179
version: v0.7.0
version: v0.9.0
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.

Copy link
Owner

@ludeeus ludeeus left a comment

Choose a reason for hiding this comment

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

Thanks 👍

@ludeeus ludeeus merged commit e5c9260 into ludeeus:master Jan 28, 2023
@Cireo Cireo deleted the patch-1 branch March 22, 2023 20:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants