Use the `checkout_path` for getting the commit oid #956

aeisenberg · 2022-02-28T20:36:45Z

Ensure that repos checked out in a non-standard location can still be uploaded.

Here is a sample PR in a different repo that uses the checkout_path: https://github.com/aeisenberg/actions-test2/pull/4/checks

I created an integration test that validates that checkout_path is doing what it should. Looking at the logs, I can see that the test is doing the right thing, but I'm not able to get the test to fail when checkout_path is not set. So, this still needs a bit of work. Ideally, we would upload the sarif file and verify that the commit_oid is correct, but our tests cannot actually upload any sarif, so that makes checking a little bit harder.

EDIT: I think I have it. See the new integration test.

When running in test mode, payloads will not be uploaded. Instead, they
will be saved to disk so that they can be inspected later.

This change will also require a documentation fix.

I'm not entirely happy with this since to get this working, the init action requires a source-path input and the analyze action requires a checkout_path. But we can specify this in the doc changes.

Fixes #952

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.

aeisenberg · 2022-02-28T22:49:34Z

Still trying to figure out how to verify that the integration test is passing (other than by visually inspecting the log). We need to validate that the commitOid of the payload that would have been invoked is the same as that of the second checkout. One possibility is that I can change the determineMergeBaseCommitOid and getCommitOid methods to write a file to disk with the payload parameters if the action is in debug mode. And the test can validate these parameters after the upload step.

This commit also adds a new integration check to verify this. When running in test mode, payloads will not be uploaded. Instead, they will be saved to disk so that they can be inspected later.

cklin · 2022-03-04T19:38:27Z

pr-checks/checks/with-checkout-path.yml

+      source-path: x/y/z/some-path/tests/multi-language-repo
+      debug: true
+  - name: Build code (non-windows)
+    shell:


Is this intentional? Similarly for Build code (windows).

Hmmm...it should be bash. Here and below.

cklin · 2022-03-04T19:40:04Z

pr-checks/checks/with-checkout-path.yml

+      debug: true
+  - name: Build code (non-windows)
+    shell:
+    if: ${{ !startsWith(matrix.os, 'windows-') }}


An alternative is to check runner.os.
https://docs.github.com/en/actions/learn-github-actions/contexts#runner-context

Yes. That's true. It's cleaner to use runner.os. I'll make the change.

aeisenberg

Thanks for your review!

aeisenberg · 2022-03-04T19:48:58Z

pr-checks/checks/with-checkout-path.yml

+      source-path: x/y/z/some-path/tests/multi-language-repo
+      debug: true
+  - name: Build code (non-windows)
+    shell:


Hmmm...it should be bash. Here and below.

aeisenberg · 2022-03-04T19:50:16Z

pr-checks/checks/with-checkout-path.yml

+      debug: true
+  - name: Build code (non-windows)
+    shell:
+    if: ${{ !startsWith(matrix.os, 'windows-') }}


Yes. That's true. It's cleaner to use runner.os. I'll make the change.

aeisenberg · 2022-03-11T16:04:50Z

Fixes #944

aeisenberg · 2022-03-25T17:34:08Z

@criemen I fixed the hang we were seeing by changing from java to csharp for with-checkout-path.yml. Not happy with that, and maybe we should take a deeper look into this.

aeisenberg · 2022-03-25T18:02:50Z

Merging this PR since the previously hanging integration tests are unrelated.

aeisenberg force-pushed the aeisenberg/checkout-path-commitoid branch 5 times, most recently from d4d4a0a to 471d7af Compare February 28, 2022 21:22

aeisenberg marked this pull request as ready for review February 28, 2022 22:41

aeisenberg requested a review from a team as a code owner February 28, 2022 22:41

aeisenberg marked this pull request as draft February 28, 2022 22:42

aeisenberg force-pushed the aeisenberg/checkout-path-commitoid branch 2 times, most recently from b8a2c1e to 9acab1b Compare March 1, 2022 06:15

aeisenberg marked this pull request as ready for review March 1, 2022 06:15

aeisenberg force-pushed the aeisenberg/checkout-path-commitoid branch from 9acab1b to d7473a8 Compare March 1, 2022 16:07

Use the checkout_path for getting the commit oid

a92e877

This commit also adds a new integration check to verify this. When running in test mode, payloads will not be uploaded. Instead, they will be saved to disk so that they can be inspected later.

aeisenberg force-pushed the aeisenberg/checkout-path-commitoid branch from d7473a8 to a92e877 Compare March 1, 2022 20:41

Merge branch 'main' into aeisenberg/checkout-path-commitoid

5c2600e

aeisenberg force-pushed the aeisenberg/checkout-path-commitoid branch 6 times, most recently from 72d4e07 to 98e84df Compare March 2, 2022 17:22

cklin reviewed Mar 4, 2022

View reviewed changes

aeisenberg commented Mar 4, 2022

View reviewed changes

aeisenberg force-pushed the aeisenberg/checkout-path-commitoid branch from 98e84df to 6591114 Compare March 4, 2022 20:12

cklin approved these changes Mar 4, 2022

View reviewed changes

aeisenberg force-pushed the aeisenberg/checkout-path-commitoid branch 4 times, most recently from a4e7f9e to 852be69 Compare March 10, 2022 22:35

Fix failing tests

d068f53

aeisenberg force-pushed the aeisenberg/checkout-path-commitoid branch from 852be69 to 5d444c1 Compare March 25, 2022 17:01

Merge branch 'main' into aeisenberg/checkout-path-commitoid

88db5e7

aeisenberg force-pushed the aeisenberg/checkout-path-commitoid branch from 5d444c1 to 88db5e7 Compare March 25, 2022 17:32

aeisenberg merged commit 6d1f0a0 into main Mar 25, 2022

aeisenberg deleted the aeisenberg/checkout-path-commitoid branch March 25, 2022 18:03

This was referenced Mar 30, 2022

Merge main into v2 #1004

Merged

Merge v2 into v1 #1006

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Use the `checkout_path` for getting the commit oid #956

Use the `checkout_path` for getting the commit oid #956

aeisenberg commented Feb 28, 2022 •

edited

Loading

aeisenberg commented Feb 28, 2022

cklin Mar 4, 2022

aeisenberg Mar 4, 2022

cklin Mar 4, 2022

aeisenberg Mar 4, 2022

aeisenberg left a comment

aeisenberg Mar 4, 2022

aeisenberg Mar 4, 2022

aeisenberg commented Mar 11, 2022

aeisenberg commented Mar 25, 2022

aeisenberg commented Mar 25, 2022

Use the checkout_path for getting the commit oid #956

Use the checkout_path for getting the commit oid #956

Conversation

aeisenberg commented Feb 28, 2022 • edited Loading

Merge / deployment checklist

aeisenberg commented Feb 28, 2022

cklin Mar 4, 2022

Choose a reason for hiding this comment

aeisenberg Mar 4, 2022

Choose a reason for hiding this comment

cklin Mar 4, 2022

Choose a reason for hiding this comment

aeisenberg Mar 4, 2022

Choose a reason for hiding this comment

aeisenberg left a comment

Choose a reason for hiding this comment

aeisenberg Mar 4, 2022

Choose a reason for hiding this comment

aeisenberg Mar 4, 2022

Choose a reason for hiding this comment

aeisenberg commented Mar 11, 2022

aeisenberg commented Mar 25, 2022

aeisenberg commented Mar 25, 2022

Use the `checkout_path` for getting the commit oid #956

Use the `checkout_path` for getting the commit oid #956

aeisenberg commented Feb 28, 2022 •

edited

Loading