From 8d588ff7db5a0ffdb1c96f15fd11f6ce0a66556c Mon Sep 17 00:00:00 2001
From: games647 <games647@users.noreply.github.com>
Date: Thu, 17 Jun 2021 14:16:04 +0200
Subject: [PATCH] Document codeql workflow file

---
 .github/workflows/codeql-analysis.yml | 43 ++++++++-------------------
 1 file changed, 13 insertions(+), 30 deletions(-)

diff --git a/.github/workflows/codeql-analysis.yml b/.github/workflows/codeql-analysis.yml
index 547952e9..69a0acae 100644
--- a/.github/workflows/codeql-analysis.yml
+++ b/.github/workflows/codeql-analysis.yml
@@ -1,29 +1,25 @@
-# For most projects, this workflow file will not need changing; you simply need
-# to commit it to your repository.
-#
-# You may wish to alter this file to override the set of languages analyzed,
-# or to provide custom queries or build logic.
-#
-# ******** NOTE ********
-# We have attempted to detect the languages in your repository. Please check
-# the `language` matrix defined below to confirm you have the correct set of
-# supported CodeQL languages.
-#
+# GitHub automatic code security scanning using CodeQL
+
+# Human readable name in the actions tab
 name: "CodeQL"
 
 on:
+  # Scan only for push on the primary branch for now
   push:
-    branches: [ main, codeql ]
-  pull_request:
-    # The branches below must be a subset of the branches above
     branches: [ main ]
-  schedule:
-    - cron: '34 11 * * 1'
+  pull_request:
+    branches: [ main ]
 
 jobs:
+  # job i
   analyze:
+
+    # Display name
     name: Analyze
+
+    # Environment
     runs-on: ubuntu-latest
+
     permissions:
       actions: read
       contents: read
@@ -32,10 +28,8 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
+        # Languages to scan
         language: [ 'java' ]
-        # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python' ]
-        # Learn more:
-        # https://docs.github.com/en/free-pro-team@latest/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning#changing-the-languages-that-are-analyzed
 
     steps:
     - name: Checkout repository
@@ -56,16 +50,5 @@ jobs:
     - name: Autobuild
       uses: github/codeql-action/autobuild@v1
 
-    # ℹ️ Command-line programs to run using the OS shell.
-    # 📚 https://git.io/JvXDl
-
-    # ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
-    #    and modify them (or add more) to build your code if your project
-    #    uses a compiled language
-
-    #- run: |
-    #   make bootstrap
-    #   make release
-
     - name: Perform CodeQL Analysis
       uses: github/codeql-action/analyze@v1