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

Update upload input values and logic #1598

Merged
merged 20 commits into from
Mar 23, 2023
Merged

Update upload input values and logic #1598

merged 20 commits into from
Mar 23, 2023

Conversation

angelapwen
Copy link
Contributor

@angelapwen angelapwen commented Mar 21, 2023 •
edited
Loading

  • The upload input to the analyze Action now accepts the following values:
    • always is the default value, which uploads the SARIF file to Code Scanning for successful and failed runs.
    • failure-only is recommended for customers post-processing the SARIF file before uploading it to Code Scanning. This option uploads debugging information to Code Scanning for failed runs to improve the debugging experience.
    • never avoids uploading the SARIF file to Code Scanning even if the code scanning run fails. This is not recommended for external users since it complicates debugging.
    • The legacy true and false options will be interpreted as always and failure-only respectively.

Merge / deployment checklist

  • Confirm this change is backwards compatible with existing workflows.
  • Confirm the readme has been updated if necessary.
  • Confirm the changelog has been updated if necessary.

@angelapwen angelapwen requested a review from a team as a code owner March 21, 2023 23:00
@angelapwen angelapwen force-pushed the upload-input-values branch from b6df6de to 39f1bc6 Compare March 22, 2023 17:03
henrymercer
henrymercer reviewed Mar 22, 2023
View reviewed changes
Copy link
Contributor

@henrymercer henrymercer left a comment

Choose a reason for hiding this comment

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

Nice!

analyze/action.yml Outdated Show resolved Hide resolved
CHANGELOG.md Outdated Show resolved Hide resolved
src/actions-util.ts Outdated Show resolved Hide resolved
src/init-action-post-helper.test.ts Outdated Show resolved Hide resolved
src/init-action-post-helper.test.ts Outdated Show resolved Hide resolved
src/workflow.ts Outdated Show resolved Hide resolved
henrymercer
henrymercer reviewed Mar 22, 2023
View reviewed changes
Copy link
Contributor

@henrymercer henrymercer left a comment

Choose a reason for hiding this comment

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

Some further changelog improvement suggestions!

CHANGELOG.md Outdated Show resolved Hide resolved
analyze/action.yml Outdated Show resolved Hide resolved
@angelapwen angelapwen requested a review from henrymercer March 22, 2023 18:52
henrymercer
henrymercer reviewed Mar 22, 2023
View reviewed changes
src/actions-util.ts Outdated Show resolved Hide resolved
src/actions-util.ts Outdated Show resolved Hide resolved
src/init-action-post-helper.test.ts Outdated Show resolved Hide resolved
@angelapwen angelapwen requested a review from henrymercer March 22, 2023 23:57
henrymercer
henrymercer reviewed Mar 23, 2023
View reviewed changes
src/actions-util.ts Outdated Show resolved Hide resolved
src/init-action-post-helper.test.ts Show resolved Hide resolved
src/actions-util.ts Outdated Show resolved Hide resolved
@angelapwen angelapwen requested a review from henrymercer March 23, 2023 16:24
henrymercer
henrymercer previously approved these changes Mar 23, 2023
View reviewed changes
Copy link
Contributor

@henrymercer henrymercer left a comment

Choose a reason for hiding this comment

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

Very nice!

src/actions-util.ts Outdated Show resolved Hide resolved
angelapwen and others added 19 commits March 23, 2023 09:52
@angelapwen
Update upload input description in analyze
9894ad1
@angelapwen
Update failed runs' upload SARIF logic
4052ce5 
Previously, failed runs' failed SARIF files were uploaded if the `upload` input was not `true`. Now, the failed SARIF files will be uploaded if the `upload` input was not `always`, `failure-only`, or `true`.
@angelapwen
Update green runs' upload SARIF logic
a99d06f 
Previously, we uploaded results from the `analyze` step if the `upload` input was `true`. We now upload results if the `upload` input was set to `true` or `always`.
@angelapwen
Add test cases for failure-only, never, and unrecognized input
452dc6e
@angelapwen
Minor refactoring
cb6d164
@angelapwen
Replace false with never in existing checks
8075d10
@angelapwen
Fall back to always for unrecognized input
7676afe
@angelapwen
Add CHANGELOG entry
fb18766
@angelapwen
Add unit tests for always, true, false cases
04e3995
@angelapwen @henrymercer
Clarify CHANGELOG and Action input description
3270250 
Co-authored-by: Henry Mercer <henry.mercer@me.com>
@angelapwen
Specify upload skips rather than fails in test
7e7bc84
@angelapwen
Refactor relevant into helper method
cde6edb
@angelapwen @henrymercer
Further documentation improvements
2a441e3 
Co-authored-by: Henry Mercer <henry.mercer@me.com>
@angelapwen
Update input description to match existing ones
690a1ab
@angelapwen
Refactor utility function per PR review
13a94c3
@angelapwen
Refactor test cases into loop
4469ee6
@angelapwen
Make getUploadValue synchronous
707a6bb
@angelapwen @henrymercer
Update comment
7929472 
Co-authored-by: Henry Mercer <henry.mercer@me.com>
@angelapwen
Use switch statement
54e08db
@angelapwen angelapwen force-pushed the upload-input-values branch from 46cf6c6 to 54e08db Compare March 23, 2023 16:53
@angelapwen angelapwen requested a review from henrymercer March 23, 2023 16:54
henrymercer
henrymercer previously approved these changes Mar 23, 2023
View reviewed changes
Copy link
Contributor

@henrymercer henrymercer left a comment

Choose a reason for hiding this comment

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

:shipit:

@angelapwen angelapwen enabled auto-merge (squash) March 23, 2023 16:56
@angelapwen angelapwen merged commit a21bb7f into github:main Mar 23, 2023
@github-actions github-actions bot mentioned this pull request Mar 27, 2023
Merged
6 tasks
@angelapwen angelapwen deleted the upload-input-values branch April 29, 2023 03:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@henrymercer henrymercer henrymercer approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@angelapwen @henrymercer