Skip to content

Commit b8de6cf

Browse files
authored
chore: Revise wording on step 1
1 parent f5b9b23 commit b8de6cf

File tree

1 file changed

+26
-17
lines changed

1 file changed

+26
-17
lines changed

.github/steps/1-enable-codeql.md

Lines changed: 26 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,39 +1,48 @@
11
## Step 1: Enable CodeQL
22

3-
In this first step, we'll be learning more about CodeQL and how to use it to secure your source code.
3+
In this first step, we'll be learning more about [CodeQL](https://codeql.github.com/) and how to use it to secure your source code.
44

5-
### What is GitHub code scanning?
5+
### What is GitHub Code Scanning?
66

7-
[Code scanning](https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning) is a capability that allows development teams to integrate security testing tools into the software development process. This is done using GitHub Actions. With code scanning, you can integrate many different types of tools including SAST, container, and infrastructure as code security tools.
7+
[Code scanning](https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning) is part of the [GitHub Advanced Security (GHAS)](https://docs.github.com/en/get-started/learning-about-github/about-github-advanced-security) product suite. It allows development teams to integrate security testing tools directly into the same process you already use for shipping code. It supports many types such as SAST, container, and infrastructure as code. And the best part is that the results can also live directly in GitHub next to your code. No need for context switching! 🎉
8+
9+
> [!TIP]
10+
> All of the features of GitHub Advanced Security are 100% free for public repositories.
811
912
### What is CodeQL?
1013

1114
[CodeQL](https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-with-codeql) is a static analysis testing tool that helps you identify security weaknesses such as SQL injection, cross-site scripting, and code injection issues.
1215

13-
### ⌨️ Activity: Enable code scanning with CodeQL
16+
<img width="200" align="right" alt="codeql default configuration box" src="https://github.com/user-attachments/assets/cf5ba96b-98bb-4db5-b743-bd31bceaabac"/>
1417

15-
First, we will enable code scanning with CodeQL in our repository.
18+
Typically CodeQL patterns are collected into [query suites](https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-with-codeql#about-codeql-queries) of patterns. When combined well, this can be a very powerful! To help with this, teams of security experts have pre-populated suites for many common scenarios and programming languages.
1619

17-
1. Open a new browser tab, and work on the steps in your second tab while you read the instructions in this tab.
20+
In many cases, taking advantage of CodeQL is as simple as accepting the default suite, but you can also select the extended suite or customize your own with [GitHub Actions]().
1821

19-
1. Navigate to the **Settings** tab at the top of your newly created repository.
22+
Here are some options the default configuration provides:
2023

21-
1. Under the **Security** section on the left side, select **Code security and analysis**.
24+
- **Languages:** The languages automatically detected in your repository that CodeQL will scan.
2225

23-
1. Scroll down to the section titled **Code scanning**. For the purpose of this exercise, we will focus on CodeQL analysis.
26+
- **Query suites:** A list of the available suites of patterns that will be used. The **Default** or **Extended** are provided automatically.
2427

25-
1. Click on the **Set up** dropdown menu and choose **Default**.
28+
- **Events:** Triggers for running a CodeQL scan. It's common to run before merging and on a schedule for production code.
2629

27-
<img width="400" alt="enable code scanning" src="https://github.com/user-attachments/assets/0d639af3-a8fb-4ea7-8b94-44621a34fc3c"/>
30+
### ⌨️ Activity: Enable code scanning with CodeQL
31+
32+
1. Open a second tab and navigate to this repository. Ensure you are on the **Code** tab.
2833

29-
Let's take a look at the configuration options in the modal:
34+
1. In the top navigation, select the the **Settings** tab.
3035

31-
- **Languages to analyze:** These are the languages that will be scanned by CodeQL. In this case, we will be scanning in `Python`.
32-
- **Query suites:** CodeQL [queries](https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-with-codeql#about-codeql-queries) are packaged in bundles called "suites". This section allows you to choose which query suite to use. We'll leave this set as **Default** for this exercise. For more information, see "[About CodeQL queries](https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-with-codeql#about-codeql-queries)."
33-
- **Events:** This section tells CodeQL when to scan. In this case, it's set to scan on any pull request to the `main` branch.
36+
1. In the left navigation, fine the **Security** section and select **Advanced Security**.
37+
38+
1. Scroll down and find the **Code scanning**.
39+
40+
1. In the **CodeQL** setting, click the **Set up** dropdown menu and choose **Default**.
41+
42+
<img width="400" alt="enable code scanning" src="https://github.com/user-attachments/assets/0d639af3-a8fb-4ea7-8b94-44621a34fc3c"/>
3443

35-
<img width="400" alt="codeql default configuration box" src="https://github.com/user-attachments/assets/cf5ba96b-98bb-4db5-b743-bd31bceaabac"/>
44+
1. Click **Enable CodeQL**.
3645

37-
1. Click **Enable CodeQL**
46+
> This will trigger a first run of CodeQL. You can view the progress in the **Actions** tab.
3847
3948
1. With CodeQL now enabled, Mona will check your progress and share the next steps.

0 commit comments

Comments
 (0)