Skip to content

Commit dbde6bd

Browse files
committed
Refactor code structure for improved readability and maintainability
1 parent 572b2b9 commit dbde6bd

32 files changed

Lines changed: 786 additions & 426 deletions

README.md

Lines changed: 14 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -20,18 +20,20 @@ Comprehensive L400-level technical documentation for GitHub Enterprise Cloud adm
2020

2121
### Repository Governance
2222
- [📦 Repository Governance](docs/07-repository-governance.md) - Rulesets, branch protection, templates
23-
- [🔒 Security & Compliance](docs/08-security-compliance.md) - GHAS, code scanning, audit logs
23+
- [🔒 Security & Compliance](docs/08-security-compliance.md) - GHAS split SKUs (Secret Protection + Code Security), code scanning, secret scanning, dependency review, audit logs
2424

2525
### Best Practices & Architecture
26-
- [✅ Best Practices & WAF](docs/09-best-practices-waf.md) - GitHub Well-Architected Framework principles
26+
- [✅ Best Practices & WAF](docs/09-best-practices-waf.md) - Azure WAF pillars applied to GitHub Enterprise Cloud (Reliability, Security, Operational Excellence, Performance Efficiency, Cost Optimization); see also wellarchitected.github.com for GitHub's native WAF
2727
- [🏗️ Reference Architecture](docs/10-reference-architecture.md) - Architecture diagrams and patterns
2828

2929
### Security Policies
3030
- [🛡️ Security-by-Default Policies](docs/11-security-by-default-policies.md) - Comprehensive security settings and policy recommendations for Enterprise, Organization, and Repository levels
3131
- [⚠️ GitHub Actions Security: Echo Command Injection](docs/17-github-actions-security-echo-command-injection.md) - Echo command injection vulnerability (HackerBot Claw attack) prevention in GitHub Actions workflows
3232

3333
### AI & Copilot Governance
34-
- [🤖 GitHub Copilot Governance](docs/12-github-copilot-governance.md) - Enterprise Copilot policies, settings, content exclusions, license management, and best practices
34+
- [🤖 GitHub Copilot Governance](docs/12-github-copilot-governance.md) - Enterprise Copilot policies, settings, content exclusions, license management, and best practices, including Copilot cloud agent governance and Copilot Spaces (formerly Knowledge Bases)
35+
- [💳 GitHub Copilot Usage-Based Billing Research](docs/GitHub-Copilot-Usage-Based-Billing-Research.md) - Premium requests, AI credits, cost-center allocation, and budget controls for Copilot consumption
36+
- [📊 GitHub Chargeback System Design](docs/22-github-chargeback-system-design.md) - Internal cost allocation framework for GitHub Enterprise spend (seats, Actions minutes, Copilot premium requests, GHAS committers)
3537
- [🔄 GitHub Organization Rename Impact](docs/18-github-rename-org-impact.md) - Impact analysis of renaming a GitHub organization on Copilot, EMU authentication, and post-rename actions
3638

3739
### Implementation Guides
@@ -48,6 +50,7 @@ Comprehensive L400-level technical documentation for GitHub Enterprise Cloud adm
4850
- [� Azure Pipelines with GitHub Repos Integration](docs/15-azure-pipelines-github-repos-integration.md) - Impact analysis of using Azure Pipelines with GitHub repositories after migration
4951
- [🔍 Azure DevOps to GitHub Migration Analysis](docs/16-azure-devops-to-github-migration-analysis.md) - Detailed technical analysis of the migration process
5052
- [🔑 ADO REST API Authentication Without PATs](docs/ado-rest-api-auth-without-pat.md) - Alternatives to Personal Access Tokens for Azure DevOps REST API authentication in CI/CD pipelines
53+
- [🧹 ADO Tenant & Org Cleanup](docs/ADO-Tenant-Org-Cleanup.md) - Post-migration cleanup of Azure DevOps tenant connections, PAT policies, orphaned orgs
5154
- [❓ ADO to GitHub Migration Q&A Guide](docs/ADO-to-GitHub-Migration-QA.md) - Detailed questions and answers about migrating from Azure DevOps to GitHub using GEI
5255
- [💬 Workshop FAQ](docs/FAQ-workshop.md) - Frequently asked questions from GitHub Enterprise Admin workshops, including migration-related topics
5356

@@ -81,16 +84,16 @@ Practical exercises to reinforce GitHub administration concepts.
8184
> Additional resources to continue your GitHub Admin learning journey.
8285
8386
### Learning GitHub Admin
84-
- [Microsoft Learn - GitHub Administration Collection](https://docs.microsoft.com/en-us/users/githubtraining/collections/mom7u1gzjdxw03)
85-
- [GitHub Enterprise Onboarding Guide](https://resources.github.com/getting-started/enterprise/)
87+
- [Microsoft Learn - GitHub Administration Collection](https://learn.microsoft.com/en-us/users/githubtraining/collections/mom7u1gzjdxw03)
88+
- [GitHub Enterprise Onboarding Guide](https://docs.github.com/en/enterprise-cloud@latest/admin/overview/setting-up-a-trial-of-github-enterprise-cloud) (Enterprise Cloud)
8689
- [The Book on GitHub Enterprise Cloud Adoption](https://resources.github.com/devops/get-started-with-github-enterprise-cloud/)
8790
- [GitHub Skills](https://skills.github.com/)
8891

8992
### GitHub Admin Documentation
9093
- [Enterprise administrators](https://docs.github.com/en/enterprise-cloud@latest/admin)
9194
- [Organizations](https://docs.github.com/en/enterprise-cloud@latest/organizations)
9295
- [Repositories](https://docs.github.com/en/enterprise-cloud@latest/repositories)
93-
- [Roles in an organization](https://docs.github.com/en/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization#permission-levels-for-an-organization)
96+
- [Roles in an organization](https://docs.github.com/en/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization#about-predefined-organization-roles)
9497
- [Configuring SCIM provisioning for Enterprise Managed Users](https://docs.github.com/en/enterprise-cloud@latest/admin/identity-and-access-management/using-enterprise-managed-users-and-saml-for-iam/configuring-scim-provisioning-for-enterprise-managed-users)
9598
- [About Enterprise Managed Users](https://docs.github.com/en/enterprise-cloud@latest/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-enterprise-managed-users)
9699
- [Managing a branch protection rule](https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/managing-a-branch-protection-rule)
@@ -103,17 +106,18 @@ Practical exercises to reinforce GitHub administration concepts.
103106
- [admin Archives | The GitHub Blog](https://github.blog/changelog/label/admin/)
104107

105108
### Videos
109+
> Note: The videos below are from GitHub Universe 2021 and may show superseded UI. For current sessions see https://www.youtube.com/githubtraining .
106110
- [What's new for GitHub Enterprise - GitHub Universe 2021 - YouTube](https://www.youtube-nocookie.com/embed/ZZviWZgrqhM)
107111
- [GitHub in the Enterprise - GitHub Universe 2021 - YouTube](https://www.youtube.com/watch?v=1-i39RqaxRs)
108112
- [Enforcing information security policy through GitHub Enterprise - GitHub Universe 2021 - YouTube](https://www.youtube-nocookie.com/embed/DCu-ZTT7WTI)
109113
- [GitHub Universe](https://githubuniverse.com/)
110114

111115
### Articles & Guides
112116
- [Best practices for organizations and teams using GitHub Enterprise Cloud](https://github.blog/2023-08-02-best-practices-for-organizations-and-teams-using-github-enterprise-cloud/)
113-
- [Everything new from GitHub Universe 2022](https://github.blog/2022-11-09-everything-new-from-github-universe-2022/)
117+
- [Everything new from GitHub Universe 2022](https://github.blog/2022-11-09-everything-new-from-github-universe-2022/) (2022 — refer to GitHub's blog for more recent announcements)
114118
- [Improved management for GitHub Enterprise owners | The GitHub Blog](https://github.blog/2022-03-10-improved-management-github-enterprise-owners/)
115119
- [How to secure your GitHub organization and enterprise account | The GitHub Blog](https://github.blog/2020-07-23-how-to-secure-your-github-organization-and-enterprise-account/)
116-
- [Connect GitHub Enterprise Cloud to Defender for Cloud Apps | Microsoft Docs](https://docs.microsoft.com/en-us/defender-cloud-apps/connect-github-ec)
117-
- [How Defender for Cloud Apps helps protect your GitHub Enterprise environment | Microsoft Docs](https://docs.microsoft.com/en-us/defender-cloud-apps/protect-github)
118-
- [GitHub Workflow Guide](https://github.github.com/services-workflow-guide/#/)
120+
- [Connect GitHub Enterprise Cloud to Defender for Cloud Apps | Microsoft Docs](https://learn.microsoft.com/en-us/defender-cloud-apps/connect-github-ec)
121+
- [How Defender for Cloud Apps helps protect your GitHub Enterprise environment | Microsoft Docs](https://learn.microsoft.com/en-us/defender-cloud-apps/protect-github)
122+
- [GitHub Workflow Guide](https://docs.github.com/en/get-started/using-github/github-flow)
119123
- [Removing sensitive data from a repository - GitHub Docs](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/removing-sensitive-data-from-a-repository)

docs/01-enterprise-hierarchy.md

Lines changed: 27 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,28 @@
11
# GitHub Enterprise Cloud Hierarchy
22

3+
> **Document status**
4+
>
5+
> - **Last reviewed:** 2026-05-19
6+
> - **Authorship:** Drafted with AI assistance (GitHub Copilot, multi-model review) and reviewed by a human maintainer before publication.
7+
> - **Sources:** Based on public documentation — primarily [docs.github.com](https://docs.github.com), [learn.microsoft.com](https://learn.microsoft.com), and official vendor blogs cited inline.
8+
> - **Verify before acting:** GitHub and Microsoft update product documentation continuously. Re-confirm against the live source pages before relying on this content for production decisions.
9+
10+
## Table of Contents
11+
12+
- [Overview](#overview)
13+
- [Enterprise Account Capabilities](#enterprise-account-capabilities)
14+
- [Hierarchy Levels](#hierarchy-levels)
15+
- [Enterprise Roles](#enterprise-roles)
16+
- [Enterprise Settings and Dashboard Navigation](#enterprise-settings-and-dashboard-navigation)
17+
- [Multi-Organization Management Patterns](#multi-organization-management-patterns)
18+
- [Enterprise Admin Responsibilities Flow](#enterprise-admin-responsibilities-flow)
19+
- [Enterprise Audit Log and Compliance Features](#enterprise-audit-log-and-compliance-features)
20+
- [Best Practices for Enterprise Administration](#best-practices-for-enterprise-administration)
21+
- [Advanced Topics](#advanced-topics)
22+
- [Migration and Onboarding Strategies](#migration-and-onboarding-strategies)
23+
- [Troubleshooting Common Issues](#troubleshooting-common-issues)
24+
- [References](#references)
25+
326
## Overview
427

528
GitHub Enterprise Cloud (GHEC) provides a multi-tiered organizational structure that enables large organizations to manage multiple teams, projects, and repositories under a unified enterprise account. This hierarchical model facilitates centralized governance, billing, and policy enforcement while maintaining organizational autonomy and flexibility.
@@ -15,7 +38,7 @@ An enterprise account on GitHub Enterprise Cloud delivers advanced administrativ
1538
**Centralized Management**
1639
- Unified dashboard providing real-time visibility across all organizations
1740
- Consolidated user management with enterprise-level identity provisioning
18-
- Single sign-on (SSO) enforcement via SAML 2.0 or OIDC
41+
- Single sign-on (SSO) enforcement via SAML 2.0 (all enterprises); OIDC available for Enterprise Managed Users (EMU) enterprises only
1942
- Centralized billing with cost allocation and usage analytics
2043

2144
**Security and Compliance**
@@ -27,7 +50,7 @@ An enterprise account on GitHub Enterprise Cloud delivers advanced administrativ
2750

2851
**Policy Enforcement**
2952
- Repository policy management across organizations
30-
- Branch protection rules inheritance
53+
- Repository Rulesets (applicable at enterprise → organization → repository scope)
3154
- Required workflows for GitHub Actions
3255
- Custom repository roles and permissions
3356
- Dependency management and security advisories
@@ -302,7 +325,7 @@ The Settings area provides access to critical configuration options:
302325
- Runner group management and registration
303326

304327
**Audit Log**
305-
- Searchable event log with 180+ day retention
328+
- Searchable event log with 180-day retention (extendable via log streaming to external SIEM)
306329
- Export capabilities (JSON, CSV)
307330
- Real-time event streaming to SIEM platforms
308331
- Compliance reporting and anomaly detection
@@ -626,7 +649,7 @@ For long-term retention and advanced analytics, configure audit log streaming:
626649
EMU provides complete lifecycle management of user identities through your Identity Provider:
627650

628651
**Key Characteristics**
629-
- GitHub manages user accounts on your behalf
652+
- User accounts are provisioned and managed by your identity provider (IdP) via SCIM
630653
- Users can only authenticate via enterprise SSO
631654
- No personal GitHub account interactions
632655
- Usernames follow configurable pattern (e.g., `octocat_corp`)

docs/02-organization-strategies.md

Lines changed: 21 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,24 @@
11
# Organization Design Patterns and Strategies
22

3+
> **Document status**
4+
>
5+
> - **Last reviewed:** 2026-05-19
6+
> - **Authorship:** Drafted with AI assistance (GitHub Copilot, multi-model review) and reviewed by a human maintainer before publication.
7+
> - **Sources:** Based on public documentation — primarily [docs.github.com](https://docs.github.com), [learn.microsoft.com](https://learn.microsoft.com), and official vendor blogs cited inline.
8+
> - **Verify before acting:** GitHub and Microsoft update product documentation continuously. Re-confirm against the live source pages before relying on this content for production decisions.
9+
10+
## Table of Contents
11+
12+
- [Overview](#overview)
13+
- [Single Organization Pattern](#single-organization-pattern)
14+
- [Multi-Organization Patterns](#multi-organization-patterns)
15+
- [Organization Naming Conventions](#organization-naming-conventions)
16+
- [Migration Strategies Between Patterns](#migration-strategies-between-patterns)
17+
- [Organization Strategy Decision Matrix](#organization-strategy-decision-matrix)
18+
- [Organization Lifecycle Management](#organization-lifecycle-management)
19+
- [Cross-References](#cross-references)
20+
- [References](#references)
21+
322
## Overview
423

524
Organization architecture represents one of the most critical design decisions in GitHub Enterprise Cloud (GHEC) deployment. The organizational structure directly impacts security boundaries, policy enforcement, cost allocation, compliance posture, and operational efficiency. This document provides expert-level guidance on selecting, implementing, and evolving organization design patterns for enterprise-scale GitHub deployments.
@@ -159,7 +178,7 @@ graph TD
159178

160179
### Red-Green-Sandbox-Archive Pattern
161180

162-
The Red-Green-Sandbox-Archive pattern is GitHub's **recommended multi-organization model** for enterprises that need more than a single organization. This pattern is based on **visibility and access control levels**, not deployment environments.
181+
The Red-Green-Sandbox-Archive pattern is a well-established multi-organization model widely used in GitHub Enterprise Cloud deployments. This pattern is based on **visibility and access control levels**, not deployment environments.
163182

164183
> **Reference:** This pattern is officially documented in [Strategies for using organizations in GitHub Enterprise Cloud](https://resources.github.com/learn/pathways/administration-governance/essentials/strategies-for-using-organizations-github-enterprise-cloud/).
165184
@@ -269,7 +288,7 @@ The Sandbox organization provides a **shared space where any user can create and
269288
- Abandoned experiments are periodically cleaned up or archived
270289
- No expectation of long-term maintenance
271290

272-
> **Note:** A Sandbox organization is especially important if you configure GHEC to prevent developers from creating personal repositories.
291+
> **Note:** A Sandbox organization is especially important if you use Enterprise Managed Users (EMU) and configure the enterprise policy to block user-namespace repository creation. Note: This policy is EMU-only; in personal-account enterprises, GitHub cannot prevent personal repository creation.
273292
274293
#### Archive Organization (Optional)
275294

0 commit comments

Comments
 (0)