Skip to content

Commit 8c082da

Browse files
authored
Merge pull request #5 from MrGDCrazy/MrGDCrazy-patch-1
Refactor CodeQL workflow for better readability
2 parents 34c6729 + 8e3da70 commit 8c082da

1 file changed

Lines changed: 28 additions & 52 deletions

File tree

.github/workflows/codeql.yml

Lines changed: 28 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,3 @@
1-
# For most projects, this workflow file will not need changing; you simply need
2-
# to commit it to your repository.
3-
#
4-
# You may wish to alter this file to override the set of languages analyzed,
5-
# or to provide custom queries or build logic.
6-
#
7-
# ******** NOTE ********
8-
# We have attempted to detect the languages in your repository. Please check
9-
# the `language` matrix defined below to confirm you have the correct set of
10-
# supported CodeQL languages.
11-
#
121
name: "CodeQL Advanced"
132

143
on:
@@ -22,20 +11,10 @@ on:
2211
jobs:
2312
analyze:
2413
name: Analyze (${{ matrix.language }})
25-
# Runner size impacts CodeQL analysis time. To learn more, please see:
26-
# - https://gh.io/recommended-hardware-resources-for-running-codeql
27-
# - https://gh.io/supported-runners-and-hardware-resources
28-
# - https://gh.io/using-larger-runners (GitHub.com only)
29-
# Consider using larger runners or machines with greater resources for possible analysis time improvements.
3014
runs-on: ${{ (matrix.language == 'swift' && 'macos-latest') || 'ubuntu-latest' }}
3115
permissions:
32-
# required for all workflows
3316
security-events: write
34-
35-
# required to fetch internal or private CodeQL packs
3617
packages: read
37-
38-
# only required for workflows in private repositories
3918
actions: read
4019
contents: read
4120

@@ -47,52 +26,49 @@ jobs:
4726
build-mode: none
4827
- language: javascript-typescript
4928
build-mode: none
50-
# CodeQL supports the following values keywords for 'language': 'actions', 'c-cpp', 'csharp', 'go', 'java-kotlin', 'javascript-typescript', 'python', 'ruby', 'rust', 'swift'
51-
# Use `c-cpp` to analyze code written in C, C++ or both
52-
# Use 'java-kotlin' to analyze code written in Java, Kotlin or both
53-
# Use 'javascript-typescript' to analyze code written in JavaScript, TypeScript or both
54-
# To learn more about changing the languages that are analyzed or customizing the build mode for your analysis,
55-
# see https://docs.github.com/en/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/customizing-your-advanced-setup-for-code-scanning.
56-
# If you are analyzing a compiled language, you can modify the 'build-mode' for that language to customize how
57-
# your codebase is analyzed, see https://docs.github.com/en/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/codeql-code-scanning-for-compiled-languages
29+
5830
steps:
5931
- name: Checkout repository
6032
uses: actions/checkout@v4
6133

62-
# Add any setup steps before running the `github/codeql-action/init` action.
63-
# This includes steps like installing compilers or runtimes (`actions/setup-node`
64-
# or others). This is typically only required for manual builds.
65-
# - name: Setup runtime (example)
66-
# uses: actions/setup-example@v1
34+
- name: Install pnpm
35+
if: matrix.language == 'javascript-typescript'
36+
uses: pnpm/action-setup@v4
37+
with:
38+
version: 10.26.1
39+
run_install: false
40+
41+
- name: Setup Node.js
42+
if: matrix.language == 'javascript-typescript'
43+
uses: actions/setup-node@v4
44+
with:
45+
node-version: 20
46+
47+
- name: Install dependencies
48+
if: matrix.language == 'javascript-typescript'
49+
shell: bash
50+
run: |
51+
if [ -f package-lock.json ] || [ -f npm-shrinkwrap.json ]; then
52+
npm ci
53+
elif [ -f pnpm-lock.yaml ]; then
54+
echo "pnpm lockfile found; installing dependencies with pnpm"
55+
corepack enable
56+
pnpm install --frozen-lockfile
57+
else
58+
echo "No recognized lockfile found; skipping dependency installation"
59+
fi
6760
68-
# Initializes the CodeQL tools for scanning.
6961
- name: Initialize CodeQL
7062
uses: github/codeql-action/init@v4
7163
with:
7264
languages: ${{ matrix.language }}
7365
build-mode: ${{ matrix.build-mode }}
74-
# If you wish to specify custom queries, you can do so here or in a config file.
75-
# By default, queries listed here will override any specified in a config file.
76-
# Prefix the list here with "+" to use these queries and those in the config file.
77-
78-
# For more details on CodeQL's query packs, refer to: https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
79-
# queries: security-extended,security-and-quality
8066

81-
# If the analyze step fails for one of the languages you are analyzing with
82-
# "We were unable to automatically build your code", modify the matrix above
83-
# to set the build mode to "manual" for that language. Then modify this step
84-
# to build your code.
85-
# ℹ️ Command-line programs to run using the OS shell.
86-
# 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
8767
- name: Run manual build steps
8868
if: matrix.build-mode == 'manual'
8969
shell: bash
9070
run: |
91-
echo 'If you are using a "manual" build mode for one or more of the' \
92-
'languages you are analyzing, replace this with the commands to build' \
93-
'your code, for example:'
94-
echo ' make bootstrap'
95-
echo ' make release'
71+
echo 'Replace this with your manual build commands'
9672
exit 1
9773
9874
- name: Perform CodeQL Analysis

0 commit comments

Comments
 (0)