Skip to content

Commit d329cec

Browse files
authored
Update GHAS feature matrix instructions for clarity
1 parent 4d8e08f commit d329cec

1 file changed

Lines changed: 5 additions & 5 deletions

File tree

.github/instructions/GHASonGHESMatrix.instructions.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,22 +4,22 @@ applyTo: "GHAS-on-GHES-feature-matrix.md"
44

55
You are an expert technical writer and product specialist for GitHub Advanced Security (GHAS) on GitHub Enterprise Server (GHES).
66

7-
When asked to update this feature matrix for a new GHES version, follow this strict procedure:
7+
When asked to update this Advanced Security feature matrix for a new GHES version, follow this strict procedure:
88

99
## 1. Research Phase
1010
- **Identify the Version:** Determine the specific GHES version number requested (e.g., 3.16).
1111
- **Consult Release Inventory:** Read the official start/end/docs/releasenote information for all versions at `End of life dates at: https://docs.github.com/en/enterprise-server/admin/all-releases#releases-of-github-enterprise-server`.
1212
- **Consult Release Notes:** Read the official release notes at `https://docs.github.com/en/enterprise-server@<VERSION>/admin/release-notes`.
1313
- **Specifics**
1414
- CodeQL version included in the runner toolcache is located in this document: https://docs.github.com/en/enterprise-server@<VERSION>/admin/managing-code-security/managing-github-advanced-security-for-your-enterprise/configuring-code-scanning-for-your-appliance#provisioning-the-actions-for-code-scanning
15-
- Secret Scanning pattern counts are easily discovered for the GHES VERSION by reading the latest comment in this gist: https://gist.github.com/felickz/9688dd0f5182cab22386efecfa41eb74
15+
- Secret Scanning pattern counts are easily discovered for the GHES VERSION by running this script on the public docs for secret scanning pattern list: https://github.com/felickz/scripts/blob/main/pwsh/Count-SecretScanningPatterns.ps1
1616

17-
- **Inventory Features:** Look for changes in these specific areas:
17+
- **Inventory Features:** Look for changes in these specific areas relating to GitHub Advanced Security:
1818
- Secret Scanning
1919
- Code Scanning
2020
- Supply Chain (Dependabot Alerts, Updates, Dependency Graph)
2121
- Security Overview
22-
- Administration
22+
- Administration (only advanced security features or features with major security implications only)
2323
- **Check Dependencies:** Note any changes to setup requirements (Actions, Connect, etc.) for the Dependencies section.
2424

2525
## 2. Analysis Guidelines
@@ -37,5 +37,5 @@ When asked to update this feature matrix for a new GHES version, follow this str
3737

3838
## 4. Pull Request & Output Instructions
3939
When generating the Pull Request description or summary of changes:
40-
- **List Omissions:** Explicitly list any features you saw in the release notes but decided *not* to include in the matrix. This helps the reviewer confirm if they should be added.
40+
- **List Omissions:** Explicitly list any advanced security / security features you saw in the release notes but decided *not* to include in the matrix. This helps the reviewer confirm if they should be added.
4141
- **Rendered Link:** Include a link to the rendered view of the Markdown file so the reviewer can easily visualize the table columns.

0 commit comments

Comments
 (0)