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

updated the outputs in readme.md #22

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

updated the outputs in readme.md #22

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
8 changes: 3 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,18 +108,16 @@ in security breach "dangerous") side-effects.

### ``failure``

Whether this check decided that the job matrix failed.

This check determines whether the job matrix has failed and returns the status as `success`.
Copy link
Member

Choose a reason for hiding this comment

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

This doesn't look right. Why would failure be a success?


### ``result``

Failure or success result of the job matrix.
returns `failure` or `success` as result of the job matrix.
Copy link
Member

Choose a reason for hiding this comment

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

It's probably worth noting that these are strings and make the sentence start with a capital letter.

Suggested change
returns `failure` or `success` as result of the job matrix.
Returns `'failure'` or `'success'` as result of the job matrix.



### ``success``

Whether this check decided that the job matrix succeeded.

This check determines whether the job matrix has succeeded and returns the status as `success`.
Copy link
Member

Choose a reason for hiding this comment

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

I don't think this is correct. Pretty sure, both success and failure outputs are true or false. Only result contains a string 'success' or 'failure'.


## Gotchas

Expand Down