FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

Update `upload` input values and logic by angelapwen · Pull Request #1598 · github/codeql-action · GitHub

/ codeql-action Public

Update upload input values and logic - #1598

Merged
angelapwen merged 20 commits into
github:mainfrom
angelapwen:upload-input-values
Mar 23, 2023
ConversationCommits (20)ChecksFiles changed
Merged

Update upload input values and logic#1598
angelapwen merged 20 commits into
github:mainfrom
angelapwen:upload-input-values

Conversation

angelapwen commented Mar 21, 2023 •
edited
Loading

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

henrymercer left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Nice!

Comment thread analyze/action.yml Outdated
Comment thread CHANGELOG.md Outdated
Comment thread src/actions-util.ts Outdated
Comment thread src/init-action-post-helper.test.ts Outdated
Comment thread src/init-action-post-helper.test.ts Outdated
Comment thread src/workflow.ts Outdated
henrymercer reviewed Mar 22, 2023
View reviewed changes

henrymercer left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Some further changelog improvement suggestions!

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

henrymercer left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Very nice!

Comment thread src/actions-util.ts Outdated
angelapwen and others added 19 commits March 23, 2023 09:52
Update upload input description in analyze
9894ad1
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`.
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`.
Add test cases for failure-only, never, and unrecognized input
452dc6e
Minor refactoring
cb6d164
Replace false with never in existing checks
8075d10
Fall back to always for unrecognized input
7676afe
Add CHANGELOG entry
fb18766
Add unit tests for always, true, false cases
04e3995
Clarify CHANGELOG and Action input description
3270250 
Co-authored-by: Henry Mercer <henry.mercer@me.com>
Specify upload skips rather than fails in test
7e7bc84
Refactor relevant into helper method
cde6edb
Further documentation improvements
2a441e3 
Co-authored-by: Henry Mercer <henry.mercer@me.com>
Update input description to match existing ones
690a1ab
Refactor utility function per PR review
13a94c3
Refactor test cases into loop
4469ee6
Make getUploadValue synchronous
707a6bb
Update comment
7929472 
Co-authored-by: Henry Mercer <henry.mercer@me.com>
Use switch statement
54e08db
angelapwen force-pushed the upload-input-values branch from 46cf6c6 to 54e08db Compare March 23, 2023 16:53
angelapwen requested a review from henrymercer March 23, 2023 16:54
henrymercer previously approved these changes Mar 23, 2023
View reviewed changes

henrymercer left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

angelapwen enabled auto-merge (squash) March 23, 2023 16:56
angelapwen merged commit a21bb7f into github:main Mar 23, 2023
github-actions Bot mentioned this pull request Mar 27, 2023
Merged
6 tasks
angelapwen deleted the upload-input-values branch April 29, 2023 03:33
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

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

Back | FazBrowse Home | New Git URL