Skip to content

fix: update README.md #53

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

fix: update README.md #53

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Target file path. Only supports paths to subdirectories of the GitHub Actions wo

### `regex`

Boolean indicating if `file` is to be interpreted as regular expression. Defaults to `false`.
Boolean indicating if `true` is to be interpreted as regular expression. Defaults to `false`.
Copy link
Owner

Choose a reason for hiding this comment

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

The current README is correct though. This option controls wether the file parameter should be interpreted as a regex or a literal file name.

Perhaps the documentation could be a bit clearer.

Copy link

Choose a reason for hiding this comment

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

Hello @dsaltares,
Thanks for the explanation. So if the user wants to use the regular expression functionality for a file (e.g. my-file-.*.zip instead of my-file-4.0.1.zip) should the regex parameter be true or false?

I was under the assumption that it should be true for regular expression behavior.


### `octokitBaseUrl`

Expand Down