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

Add note on file types #97

Merged
merged 2 commits into from
Jul 25, 2022
Merged

Add note on file types #97

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a5e1bdc
Add note on file types
vsoch Jul 25, 2022
01a6c6e
Update README.md
vsoch Jul 25, 2022
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
11 changes: 11 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -145,6 +145,17 @@ jobs:
| `force_pass` | <span style="color:green"> optional </span> | Choose whether to force a pass when checks are done. |
| `workers` | <span style="color:green"> optional </span> | The number of checks (one per file) to run in parallel, defaults to 9 |

## Details

### Hidden File Types

If you need to specify a file_types pattern to include hidden files, you'll need a `.*` pattern that is provided in the context of a comma separated list, for example:

```yaml
file_types: '.*,'
Copy link
Member

Choose a reason for hiding this comment

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

what happens here if I only want to check the hidden files? (not sure how frequent is this scenario)
based on this, I will need to exclude the other non-hidden types right?
To do that, the only option I see is exclude_files but that requires full path right? or can I use a pattern?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I think if you add this file types filter it would exclude all the other patterns - in the same way doing *.md only includes markdown. But I haven’t tried it recently!

Copy link

Choose a reason for hiding this comment

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

Yes, I use this on a dotfiles repo (where it's all "hidden" files) and this is the pattern I use, after guidance in #76.

Copy link
Member

@SuperKogito SuperKogito Jul 25, 2022 •
edited
Loading

Choose a reason for hiding this comment

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

Then that's perfect 👍

```
If there is another pattern or variable specification that you'd like to see an example of here, please [open an issue](https://github.com/urlstechie/urlchecker-action/issues).

## Demo
- Using version > 0.1.4
<img src="demo2.gif"/>
Expand Down