Skip to content

Commit 294560a

Browse files
Convert additional links to reference format
1 parent ae0fa02 commit 294560a

File tree

1 file changed

+9
-6
lines changed

1 file changed

+9
-6
lines changed

content/full-day/1-code-scanning.md

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -43,30 +43,30 @@ You have now enabled Dependabot alerts and security updates! Should an insecure
4343

4444
Many developers have checked in code with a token or username and passwords. Sometimes this is because the developer was trying to take a shortcut, sometimes it was because they didn't know the proper mechanism to secure the key, and sometimes it was done under the assumption they'll clean it up later but never do.
4545

46-
Regardless of the reason, even seemingly innocuous tokens can create a security issue. We always want to take care to not publish tokens and keys, and detect any issues as quickly as possible. Secret scanning is built to do exactly this. When a token is detected in your source code, an alert will be raised. You can even enable push protection, ensuring any code with a [supported secret](https://docs.github.com/en/code-security/secret-scanning/secret-scanning-patterns#supported-secrets) can't be pushed to your repository.
46+
Regardless of the reason, even seemingly innocuous tokens can create a security issue. We always want to take care to not publish tokens and keys, and detect any issues as quickly as possible. Secret scanning is built to do exactly this. When a token is detected in your source code, an alert will be raised. You can even enable push protection, ensuring any code with a [supported secret][supported-secrets] can't be pushed to your repository.
4747

4848
### Enabling secret scanning
4949

5050
Let's enable Secret scanning to detect any potential keys.
5151

5252
1. On the same page (**Settings** > **Code security and analysis**), towards the very bottom, locate the **Secret scanning** section.
5353
1. Next to **Receive alerts on GitHub for detected secrets, keys or other tokens**, select **Enable**.
54-
1. Next to **Push protection**, select **Enable** to block pushes to the repository which contain a [supported secret](https://docs.github.com/en/code-security/secret-scanning/secret-scanning-patterns#supported-secrets).
54+
1. Next to **Push protection**, select **Enable** to block pushes to the repository which contain a [supported secret][supported-secrets].
5555

5656
![Screenshot of fully configured secret scanning](./images/1-secret-scanning.png)
5757

5858
You've now enabled secret scanning and push protection. This helps you both block keys from being pushed to your repository and quickly detect when a key has been added to your source code.
5959

6060
## Code scanning
6161

62-
There is a direct relationship between the amount of code an organization creates and potential attack vectors. We always want to check our source code for vulnerabilities. [Code scanning](https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning) checks your source code for known vulnerabilities. When an issue is detected on a pull request, a new comment is added highlighting the line of source code providing contextual information for the developer. This allows for the issue to be quickly resolved.
62+
There is a direct relationship between the amount of code an organization creates and potential attack vectors. We always want to check our source code for vulnerabilities. [Code scanning][about-code-scanning] checks your source code for known vulnerabilities. When an issue is detected on a pull request, a new comment is added highlighting the line of source code providing contextual information for the developer. This allows for the issue to be quickly resolved.
6363

6464
> [!NOTE]
65-
> Code scanning is built atop [GitHub Actions](https://github.com/features/actions), the automation platform for GitHub. We'll explore the specifics of GitHub Actions later in this workshop and create our own workflows.
65+
> Code scanning is built atop [GitHub Actions][github-actions], the automation platform for GitHub. We'll explore the specifics of GitHub Actions later in this workshop and create our own workflows.
6666
6767
### Enabling code scanning
6868

69-
Let's enable Code scanning to detect vulnerabilities in our source code. We're going to use the default implementation, which runs whenever code is pushed to `main` or a [pull request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests) is made to `main`. It will also run on a set schedule to ensure any newly discovered potential vulnerabilities are detected.
69+
Let's enable Code scanning to detect vulnerabilities in our source code. We're going to use the default implementation, which runs whenever code is pushed to `main` or a [pull request][about-prs] is made to `main`. It will also run on a set schedule to ensure any newly discovered potential vulnerabilities are detected.
7070

7171
1. On the same page (**Settings** > **Code security and analysis**), towards the very bottom, locate the **Code scanning** section.
7272
1. Next to **CodeQL analysis**, select **Set up** > **Default**.
@@ -80,7 +80,7 @@ Let's enable Code scanning to detect vulnerabilities in our source code. We're g
8080
> [!IMPORTANT]
8181
> Your list of languages may be different
8282
83-
A background process starts, and will configure a workflow for analyzing your code using [CodeQL and code scanning](https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning).
83+
A background process starts, and will configure a workflow for analyzing your code using [CodeQL and code scanning][about-code-scanning].
8484

8585
## Summary and next steps
8686

@@ -97,8 +97,11 @@ In this exercise, you enabled GitHub Advanced Security. You enabled Dependabot t
9797

9898
[advanced-security]: https://github.com/features/security
9999
[advanced-security-docs]: https://docs.github.com/en/get-started/learning-about-github/about-github-advanced-security
100+
[about-code-scanning]: https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning
100101
[about-prs]: https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests
101102
[dependabot-quickstart]: https://docs.github.com/en/code-security/getting-started/dependabot-quickstart-guide
103+
[github-actions]: https://github.com/features/actions
104+
[supported-secrets]: https://docs.github.com/en/code-security/secret-scanning/secret-scanning-patterns#supported-secrets
102105
[skills-supply-chain]: https://github.com/skills/secure-repository-supply-chain
103106
[skills-secure-code]: https://github.com/skills/secure-code-game
104107
[walkthrough-previous]: 0-setup.md

0 commit comments

Comments
 (0)