Fix Swift PR Checks on `nightly-latest` CLI #1696

angelapwen · 2023-05-23T18:46:41Z

Now that Swift analysis is on by default in the latest nightly CLI version, we are autodetecting Swift, but Swift is not set up in this workflow. This change fixes the Swift setup workflow to unblock CI by:

adding setup-swift workflow, and CODEQL_ENABLE_EXPERIMENTAL_FEATURES_SWIFT for all versions except nightly-latest to the debug artifacts check
no longer setting the CODEQL_ENABLE_EXPERIMENTAL_FEATURES_SWIFT flag for the nightly-latest CLI version, for any other check. This allows us to test the case where the flag is not set for nightly-latest as well.
updating the setup-swift workflow to only set up Swift if the codeql resolve languages includes Swift.

Once CLI v2.13.3 is released, we can stop setting the experimental flag for latest.

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.

Now that Swift analysis is on by default, we are autodetecting Swift, but Swift is not set up in this workflow. This change adds the Swift setup workflow.

We now can (and need to) to run these steps without the environment variable being set in the other PR checks.

angelapwen · 2023-05-23T18:57:12Z

Oh no, the step is now failing on past CLI versions. I'll simply pass the environment variable to the failing test then, and we can do The Right Thing when we remove the experimental flag for new versions.

We cannot remove the conditional in the `setup-swift` workflow because it will fail to find the Swift extractor in prior versions without the experimental flag set. For now we replace the conditional and pass the experimental flag to the failing PR check.

henrymercer

How about:

Updating the autogenerated "Set environment variable for Swift enablement" step to stop setting CODEQL_ENABLE_EXPERIMENTAL_FEATURES_SWIFT=true on nightly-latest
Updating .github/actions/setup-swift to run Swift setup if we're running on macOS/Linux and swift is included in codeql resolve languages (Note that based on this, Linux analysis requires 5.7.3)

This should handle the case where Swift is enabled by default in nightly-latest. Once 2.13.3 is released, we can remove latest from the list in "Set environment variable for Swift enablement".

.github/actions/setup-swift/action.yml

pr-checks/sync.py

henrymercer

Thanks for making the changes, I think it made sense to do the work of updating the PR checks now. I think the only remaining piece is to update multi-language-autodetect.yml to check language autodetection for Swift on nightly-latest too. This is the only remaining read of CODEQL_ENABLE_EXPERIMENTAL_FEATURES_SWIFT I found in the codebase.

pr-checks/sync.py

henrymercer · 2023-05-24T12:25:43Z

.github/workflows/debug-artifacts.yml

+      - uses: ./../action/.github/actions/setup-swift
+        if: matrix.version == 'nightly-latest'
+        with:
+          codeql-path: ${{ steps.init.outputs.codeql-path }}


Nice, I think we just need to add id: init to the init step to make this work.

Ah... I was wondering what the failure was coming from. Thanks.

Co-authored-by: Andrew Eisenberg <aeisenberg@github.com>

angelapwen · 2023-05-24T16:31:41Z

I think the only remaining piece is to update multi-language-autodetect.yml to check language autodetection for Swift on nightly-latest too. This is the only remaining read of CODEQL_ENABLE_EXPERIMENTAL_FEATURES_SWIFT I found in the codebase.

Nice find — I've modified it to check on nightly-latest when the platform isn't Windows, in addition to when the experimental flag is set.

henrymercer · 2023-05-24T16:53:32Z

pr-checks/checks/multi-language-autodetect.yml

@@ -66,7 +66,9 @@ steps:
      fi

  - name: Check language autodetect for Swift
-    if: env.CODEQL_ENABLE_EXPERIMENTAL_FEATURES_SWIFT == 'true'
+    if: >- 


This looks good, but I'm slightly surprised to see us using env.CODEQL_ENABLE_EXPERIMENTAL_FEATURES_SWIFT == 'true' for Ruby too — that seems like a subset. I'm good with us addressing this separately though to unblock PR checks.

Oh yes, I noticed this as well. I wonder if it's because we had previously set the CODEQL_ENABLE_EXPERIMENTAL_FEATURES_SWIFT variable globally, but then moved it individually to specific steps. I'll open a follow-up PR.

PR at #1699

henrymercer · 2023-05-24T16:58:26Z

.github/actions/setup-swift/action.yml

-        # Specify 5.7.0, otherwise setup Action will default to latest minor version. 
-        if [ $VERSION = "5.7" ]; then
-          VERSION="5.7.0"
+        if [ $SWIFT_EXTRACTOR_DIR = "null" ]; then


Not critical here, but for the future we should quote variables to prevent problems with word splitting.

henrymercer · 2023-05-24T16:59:32Z

.github/actions/setup-swift/action.yml

      shell: bash
      env: 
        CODEQL_PATH: ${{ inputs.codeql-path }}
      run: |
-        if [ $RUNNER_OS = "macOS" ]; then
+        if [[ $RUNNER_OS = "macOS" ]]; then


Nit: we should probably pick one of (single brace, double brace) and (single equals, double equals) and run with it. I think for our purposes here they will behave the same though.

I agree! I actually changed it to double brace here to match the other instances of $RUNNER_OS.

I think the bash I've seen so far in the workflow uses single equals for equality, but the Actions syntax outside of the bash scripts use double equals. That's what I've been following at least 😅

angelapwen added 2 commits May 23, 2023 11:42

Add custom setup-swift workflow to PR check

ebb84c5

Now that Swift analysis is on by default, we are autodetecting Swift, but Swift is not set up in this workflow. This change adds the Swift setup workflow.

Unconditionally run setup-swift

0df283c

We now can (and need to) to run these steps without the environment variable being set in the other PR checks.

angelapwen marked this pull request as ready for review May 23, 2023 18:47

angelapwen requested a review from a team as a code owner May 23, 2023 18:47

henrymercer previously approved these changes May 23, 2023

View reviewed changes

henrymercer mentioned this pull request May 23, 2023

PR checks: Update requests to 2.31.0 #1695

Merged

3 tasks

angelapwen dismissed henrymercer’s stale review via f2bad39 May 23, 2023 18:59

angelapwen requested a review from henrymercer May 23, 2023 19:07

henrymercer reviewed May 23, 2023

View reviewed changes

angelapwen added 4 commits May 23, 2023 12:55

Only run setup-swift if found in codeql resolve languages

424b55e

Stop setting experimental flag on latest CLI

91268d3

Stop setting experimental flag in debug artifacts

3ee1898

Prevent running steps on Windows, fix typo

25fbb22

angelapwen changed the title ~~Add setup-swift workflow to debug artifacts PR check~~ Fix Swift PR Checks on latest CLI May 23, 2023

angelapwen changed the title ~~Fix Swift PR Checks on latest CLI~~ Fix Swift PR Checks on nightly-latest CLI May 23, 2023

Fix typos

27af7f7

angelapwen force-pushed the fix-swift-pr-check branch from ddce3a1 to 27af7f7 Compare May 23, 2023 21:35

Only run setup-swift for debug artifact if on nightly-latest

4418543

angelapwen force-pushed the fix-swift-pr-check branch from db80b58 to 4418543 Compare May 23, 2023 22:24

aeisenberg reviewed May 23, 2023

View reviewed changes

.github/actions/setup-swift/action.yml Outdated Show resolved Hide resolved

pr-checks/sync.py Show resolved Hide resolved

henrymercer reviewed May 24, 2023

View reviewed changes

henrymercer mentioned this pull request May 24, 2023

Avoid parsing SARIF file when workaround for duplicate notification locations is disabled #1697

Merged

3 tasks

angelapwen and others added 3 commits May 24, 2023 09:24

Update .github/actions/setup-swift/action.yml

f83f109

Co-authored-by: Andrew Eisenberg <aeisenberg@github.com>

Give init in workflow an id

8564eab

Check Swift autodetect on nightly-latest

4b96e7b

angelapwen requested a review from henrymercer May 24, 2023 16:50

angelapwen enabled auto-merge (squash) May 24, 2023 16:58

henrymercer approved these changes May 24, 2023

View reviewed changes

angelapwen merged commit 8c923c0 into github:main May 24, 2023
325 checks passed

angelapwen deleted the fix-swift-pr-check branch May 24, 2023 17:35

github-actions bot mentioned this pull request May 24, 2023

Merge main into releases/v2 #1700

Merged

6 tasks

This was referenced Jun 21, 2023

[Snyk] Security upgrade gulp from 3.9.1 to 4.0.0 aliscco/codeql-action#514

Open

[Snyk] Security upgrade gulp from 3.9.1 to 4.0.0 aliscco/codeql-action#551

Open

[Snyk] Security upgrade gulp from 3.9.1 to 4.0.0 aliscco/codeql-action#748

Open

This was referenced Nov 29, 2023

[Snyk] Fix for 13 vulnerabilities aliscco/codeql-action#938

Open

[Snyk] Fix for 15 vulnerabilities aliscco/codeql-action#940

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix Swift PR Checks on `nightly-latest` CLI #1696

Fix Swift PR Checks on `nightly-latest` CLI #1696

angelapwen commented May 23, 2023 •

edited

angelapwen commented May 23, 2023

henrymercer left a comment

henrymercer left a comment

henrymercer May 24, 2023

angelapwen May 24, 2023

angelapwen commented May 24, 2023 •

edited

henrymercer May 24, 2023

angelapwen May 24, 2023

angelapwen May 24, 2023

henrymercer May 24, 2023

henrymercer May 24, 2023

angelapwen May 24, 2023

Fix Swift PR Checks on nightly-latest CLI #1696

Fix Swift PR Checks on nightly-latest CLI #1696

Conversation

angelapwen commented May 23, 2023 • edited

Merge / deployment checklist

angelapwen commented May 23, 2023

henrymercer left a comment

Choose a reason for hiding this comment

henrymercer left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

angelapwen commented May 24, 2023 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Fix Swift PR Checks on `nightly-latest` CLI #1696

Fix Swift PR Checks on `nightly-latest` CLI #1696

angelapwen commented May 23, 2023 •

edited

angelapwen commented May 24, 2023 •

edited