Skip to content

Commit 5d9f834

Browse files
authored
Merge pull request #1 from skills/content-review
Content review
2 parents 22e02f6 + 6ec08ec commit 5d9f834

File tree

4 files changed

+11
-11
lines changed

4 files changed

+11
-11
lines changed

.github/steps/1-codeql-language-matrix.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -9,23 +9,23 @@ CodeQL language matrices allow you to configure your CodeQL workflows with a lan
99
### Importance of using languages matrices with code scanning
1010

1111
1. **Simplicity**: Using a language matrix with CodeQL simplifies your workflow by allowing you to manage multiple languages in a single workflow file. This eliminates the need for separate workflows for each language, making your code scanning process more streamlined and manageable.
12-
2. **Flexibility**: A language matrix provides flexibility as it allows you to easily add or remove languages from your workflow. This means you can quickly adapt your code scanning process to changes in your project's language usage.
12+
2. **Flexibility**: A language matrix provides flexibility, as it allows you to easily add or remove languages from your workflow. This means you can quickly adapt your code scanning process to changes in your project's language usage.
1313
3. **Consistency**: By using a language matrix, you ensure consistent code scanning across all languages used in your project. This helps maintain the quality and security of your codebase, regardless of the language it's written in.
1414

1515
Remember, a well-configured CodeQL setup is key to maintaining a secure and reliable codebase.
1616

1717
### :keyboard: Activity: Configure your `codeql.yml` file to use a language matrix
1818

19-
1. Navigate to the `Code` tab and locate the `.github/workflows` folder.
20-
1. Add the following content to the `codeql.yml` file before the steps section:
19+
1. In the `Code` tab, locate the `.github/workflows` folder.
20+
1. In the `codeql.yml` file, above the `steps` section, add the following:
2121
```yaml
2222
strategy:
2323
fail-fast: false
2424
matrix:
2525
language: [ 'go', 'java-kotlin', 'javascript-typescript', 'python' ]
2626
# CodeQL supports [ 'c-cpp', 'csharp', 'go', 'java-kotlin', 'javascript-typescript', 'python', 'ruby', 'swift' ]
27-
# Use only 'java-kotlin' to analyze code written in Java, Kotlin or both
28-
# Use only 'javascript-typescript' to analyze code written in JavaScript, TypeScript or both
27+
# Use only 'java-kotlin' to analyze code written in Java, Kotlin, or both
28+
# Use only 'javascript-typescript' to analyze code written in JavaScript, TypeScript, or both
2929
# Learn more about CodeQL language support at https://aka.ms/codeql-docs/language-support
3030

3131
```
@@ -35,7 +35,7 @@ Remember, a well-configured CodeQL setup is key to maintaining a secure and reli
3535
with:
3636
languages: ${{ matrix.language }}
3737
```
38-
1. Finally we need to add the language matrix to the CodeQL analyze action. Add the following to the CodeQL analyze action:
38+
1. Finally, we need to add the language matrix to the CodeQL analyze action. Add the following to the CodeQL analyze action:
3939
```yaml
4040
with:
4141
category: ${{ matrix.language }}

.github/steps/2-codeql-autobuild.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
_Nice work! :tada: You modified your workflow to use a language matrix!_
44

5-
With the language matrix specified we can see the languages that we want to scan. One of those languages is a compiled language, and as such will not work correctly with how we have the workflow set up. We need to make sure that the autobuild step is included _and_ only runs when it is needed.
5+
With the language matrix specified we can see the languages we want to scan. One of those languages is a compiled language, and as such, will not work correctly with how we have the workflow set up. We need to make sure the autobuild step is included _and_ only runs when it is needed.
66

77
Autobuild for CodeQL is a feature that automatically attempts to build any compiled languages in your repository. It works by detecting the build system in your repository and executing the appropriate commands to compile the code, enabling CodeQL to analyze the compiled language.
88

.github/steps/X-finish.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ _Congratulations friend, you've completed this course!_
77
Here's a recap of all the tasks you've accomplished in your repository:
88

99
- You've learned how to use a language matrix with CodeQL workflows.
10-
- You've learned how about the CodeQL autobuild action works.
10+
- You've learned about how the CodeQL autobuild action works.
1111
- You've learned how to use contextual expressions.
1212

1313
### Additional learning and resources

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,12 +8,12 @@ _Configure your CodeQL workflows with a language matrix to simplify your code sc
88

99
## Welcome
1010

11-
In this course we will explore how you can configure CodeQL using configuration files. During this course, we will show you how to add a query pack to a CodeQL configuration file as well as configure your workflow to reference that configuration file.
11+
In this course we will explore how you can configure CodeQL using configuration files. During this course, we will show you how to add a query pack to a CodeQL configuration file, as well as configure your workflow to reference that configuration file.
1212

1313
- **Who is this for**: Developers, security engineers, open source maintainers.
14-
- **What you'll learn**: We'll show you how to configure your workflow to use a language matrix. We will also cover the autobuild action for compiled langauges. This will allow you to have a single code scanning workflow that covers all the languages in your repository.
14+
- **What you'll learn**: We'll show you how to configure your workflow to use a language matrix. We will also cover the autobuild action for compiled languages. This will allow you to have a single code scanning workflow that covers all the languages in your repository.
1515
- **What you'll build**: A secure software development pipeline that has been tuned to your project's specific needs.
16-
- **Prerequisites**: Knowledge of how the Context and expressions work in workflows. You can learn more about this in the [GitHub Actions documentation](https://docs.github.com/en/actions).
16+
- **Prerequisites**: Knowledge of how the context and expressions work in workflows. You can learn more about this in the [GitHub Actions documentation](https://docs.github.com/en/actions).
1717
- **How long**: This course is 2 steps long and takes less than 30 minutes to complete.
1818

1919
## How to start this course

0 commit comments

Comments
 (0)