Skip to content

Commit 1d77a80

Browse files
authored
instructions
1 parent 2dafbb2 commit 1d77a80

File tree

1 file changed

+6
-4
lines changed

1 file changed

+6
-4
lines changed

.github/instructions/GHASonGHESMatrix.instructions.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,15 +12,17 @@ When asked to update this Advanced Security feature matrix for a new GHES versio
1212
- If running as an automated workflow (no user-specified version), compare the versions currently documented in the matrix against the all-releases page to detect any new major versions or recent patch releases.
1313
- **Consult Release Inventory:** Read the official start/end/docs/releasenote information for all versions at `https://docs.github.com/en/enterprise-server/admin/all-releases#releases-of-github-enterprise-server`.
1414
- **Consult Release Notes:** Read the official release notes at `https://docs.github.com/en/enterprise-server@<VERSION>/admin/release-notes`.
15+
- **Consult the GHES GA announcement blog post:** Check `https://github.blog/changelog/` for a post titled "GitHub Enterprise Server X.XX is now generally available" — this often summarizes the most notable GHAS features in plain language and may highlight items not obvious from the structured release notes.
16+
- **Consult the GitHub community discussion:** Check `https://github.com/orgs/community/discussions` for the GHES X.XX GA announcement thread, which typically lists key highlights including security features.
1517
- **Check Minor/Patch Versions:** For each currently documented major version that is still supported, check the release notes page for recent patch releases (e.g., 3.19.3 → 3.19.4) that may include significant Advanced Security feature changes such as features moving from Preview to GA, new capabilities being backported, or important security fixes.
1618
- **Specifics**
1719
- 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
1820
- 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
1921

20-
- **Inventory Features:** Look for changes in these specific areas relating to GitHub Advanced Security:
22+
- **Inventory Features:** Look for any new features / functionality in these specific areas relating to GitHub Advanced Security / Code Security / Secret Protection / Advisory Database:
2123
- Secret Scanning
2224
- Code Scanning
23-
- Supply Chain (Dependabot Alerts, Updates, Dependency Graph)
25+
- Supply Chain (Dependabot Alerts/Advisory Database, Updates, Dependency Graph)
2426
- Security Overview
2527
- Administration (Security Configurations - only advanced security features or features with major security implications only)
2628
- do not put security configuration setup for specific features under the feature section - keep the security configuration under Administration!
@@ -31,13 +33,13 @@ When asked to update this Advanced Security feature matrix for a new GHES versio
3133
- Identify if a feature is in Preview (mark with ☑️) or General Availability (mark with ✅).
3234
- Explicitly check if existing features have moved from Preview to GA in this release.
3335
- **Significance Filter:**
34-
- **INCLUDE:** New functionality, major gaps addressed, major architectural changes, new versions, counts.
36+
- **INCLUDE:** New functionality, new features, major gaps addressed, major architectural changes, new versions, counts.
3537
- **EXCLUDE:** Minor bug fixes, new versions of existing langagues/framework support added (ex: Go 1.25 or Swift 6.1.2), simple renames (e.g., "Generic" -> "Experimental"), or UI tweaks without functional impact.
3638

3739
## 3. Matrix Update Rules
3840
- **New Column:** Always add a new column for the new version in *every* feature table, even if there are no specific changes for that table.
3941
- **Carry Forward:** Pull forward the feature status from the previous version. Update the status icon only if it has changed (e.g., ☑️ to ✅).
40-
- **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.
42+
- **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/changelog for the new feature. Ensure the link renders appropriately to a docs page that describes the feature - otherwise fall back to changelog - otherwise fallback to no link.
4143
- **End-of-Life Versions:** When a version has passed its deprecation date, consider whether it should be archived. The document uses an archive pattern — see the "End of life Archive" section at the top of the matrix. Do not remove columns without moving them to the archive first.
4244
- **Dependencies Table:** The Dependencies table at the bottom of the document has a **different column structure** (Feature, GHAS license, Actions, Connect, Documentation, Notes). Do **NOT** add GHES version columns to it. Only modify the Dependencies table if there are actual dependency requirement changes.
4345

0 commit comments

Comments
 (0)