Skip to content

Commit c3f2a34

Browse files
committed
Clarify comment that explains how the test works
1 parent a83f6f5 commit c3f2a34

2 files changed

Lines changed: 13 additions & 7 deletions

File tree

‎.github/workflows/__diagnostics-without-db.yml‎

Lines changed: 6 additions & 3 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎pr-checks/checks/diagnostics-without-db.yml‎

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
name: "Diagnostic export without database"
22
description: "Tests that temporary diagnostics are correctly included in the failed SARIF."
33
versions:
4-
# Overridden by the FF below.
4+
# Overridden by the FF in the `init` step below.
55
- linked
66
installNode: true
77

@@ -15,9 +15,12 @@ env:
1515

1616
steps:
1717
# We deliberately need to make this step fail before the database is initialised, but after
18-
# some diagnostic has been produced. The simplest way to do that right now is to force the
19-
# use of a nightly release and then fail because we are attempting to analyse Swift on
20-
# a non-macOS runner.
18+
# some diagnostic has been produced. The simplest way to do that right now is to:
19+
#
20+
# - Produce a diagnostic before the db is initialised by forcing the use of a nightly release
21+
# with the `CODEQL_ACTION_FORCE_NIGHTLY` feature flag.
22+
# - Cause `init` to abort because we are attempting to analyse Swift on a non-macOS runner.
23+
#
2124
- name: Initialise failing analysis
2225
id: init
2326
uses: ./../action/init

0 commit comments

Comments
 (0)