Skip to content

Commit 8fb8b47

Browse files
committed
Consistently use JSDocs in sync.ts
1 parent 63b184d commit 8fb8b47

1 file changed

Lines changed: 7 additions & 5 deletions

File tree

‎pr-checks/sync.ts‎

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -137,15 +137,15 @@ interface LanguageSetup {
137137
/** Describes partial mappings from built-in languages to their specific setup information. */
138138
type LanguageSetups = Partial<Record<BuiltInLanguage, LanguageSetup>>;
139139

140-
// A type representing version identifiers.
140+
/** A type representing version identifiers. */
141141
type Version =
142142
| "default"
143143
| "linked"
144144
| "nightly-latest"
145145
// This is an approximation, but sufficient validation for our needs here.
146146
| `stable-v${number}.${number}.${number}`;
147147

148-
// The default set of CodeQL Bundle versions to use for the PR checks.
148+
/** The default set of CodeQL Bundle versions to use for the PR checks. */
149149
const defaultTestVersions = [
150150
// The oldest supported CodeQL version. If bumping, update `CODEQL_MINIMUM_VERSION` in `codeql.ts`
151151
"stable-v2.20.7",
@@ -324,9 +324,11 @@ const languageSetups: LanguageSetups = {
324324
},
325325
};
326326

327-
// This is essentially an arbitrary version of `yq`, which happened to be the one that
328-
// `choco` fetched when we moved away from using that here.
329-
// See https://github.com/github/codeql-action/pull/3423
327+
/**
328+
* This is essentially an arbitrary version of `yq`, which happened to be the one that
329+
* `choco` fetched when we moved away from using that here.
330+
* See https://github.com/github/codeql-action/pull/3423
331+
*/
330332
const YQ_VERSION = "v4.50.1";
331333

332334
const CHECKS_DIR = path.join(PR_CHECKS_DIR, "checks");

0 commit comments

Comments
 (0)