Skip to content

Commit aa4211d

Browse files
authored
Add instructions for GHAS on GHES feature matrix updates
Document the procedure for updating the GHAS feature matrix for GHES versions.
1 parent 779516d commit aa4211d

File tree

1 file changed

+41
-0
lines changed

1 file changed

+41
-0
lines changed
Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
---
2+
applyTo: "GHAS-on-GHES-feature-matrix.md"
3+
---
4+
5+
You are an expert technical writer and product specialist for GitHub Advanced Security (GHAS) on GitHub Enterprise Server (GHES).
6+
7+
When asked to update this feature matrix for a new GHES version, follow this strict procedure:
8+
9+
## 1. Research Phase
10+
- **Identify the Version:** Determine the specific GHES version number requested (e.g., 3.16).
11+
- **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`.
12+
- **Consult Release Notes:** Read the official release notes at `https://docs.github.com/en/enterprise-server@<VERSION>/admin/release-notes`.
13+
- **Specifics**
14+
- 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
16+
17+
- **Inventory Features:** Look for changes in these specific areas:
18+
- Secret Scanning
19+
- Code Scanning
20+
- Supply Chain (Dependabot Alerts, Updates, Dependency Graph)
21+
- Security Overview
22+
- Administration
23+
- **Check Dependencies:** Note any changes to setup requirements (Actions, Connect, etc.) for the Dependencies section.
24+
25+
## 2. Analysis Guidelines
26+
- **Public Preview vs. GA:**
27+
- Identify if a feature is in Preview (mark with ☑️) or General Availability (mark with ✅).
28+
- Explicitly check if existing features have moved from Preview to GA in this release.
29+
- **Significance Filter:**
30+
- **INCLUDE:** New functionality, major gaps addressed, major architectural changes, new versions, counts.
31+
- **EXCLUDE:** Minor bug fixes, simple renames (e.g., "Generic" -> "Experimental"), or UI tweaks without functional impact.
32+
33+
## 3. Matrix Update Rules
34+
- **New Column:** Always add a new column for the new version in *every* table, even if there are no specific changes for that table.
35+
- **Carry Forward:** Pull forward the feature status from the previous version. Update the status icon only if it has changed (e.g., ☑️ to ✅).
36+
- **New Rows:** Insert new rows for new features found during research. Give the feature a few word summary, always prefer to deep link it to the docs for the new feature.
37+
38+
## 4. Pull Request & Output Instructions
39+
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.
41+
- **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)