Skip to content

Commit 220ae26

Browse files
committed
Updated headings to follow Microsoft style guide
1 parent ce8f11a commit 220ae26

File tree

3 files changed

+29
-31
lines changed

3 files changed

+29
-31
lines changed

learn-pr/github/manage-sensitive-data-security-policies/includes/2-set-security-policies.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ Enterprise rules override org rules; org owners can’t change locked settings.
5151
- **All repos:** Access controls, SECURITY.md, Dependabot alerts/updates, advisories
5252
- **With Advanced Security:** Code scanning, secret scanning, dependency review
5353

54-
## Enhancing Enterprise Security with GitHub
54+
## Enhancing enterprise security with GitHub
5555
GitHub’s enterprise features bolster your security posture and compliance.
5656

5757
- Security Features
@@ -60,7 +60,7 @@ GitHub’s enterprise features bolster your security posture and compliance.
6060
- Compliance Support
6161
- **Compliance reports:** SOC 1 Type 2, SOC 2 Type 2, ISO/IEC 27001:2013 certifications available for audits and regulatory needs
6262

63-
## Scrubbing Sensitive Data from GitHub Repositories
63+
## Scrubbing sensitive data from GitHub repositories
6464
When secrets leak, you must rewrite history or engage GitHub support.
6565

6666
### Rewrite history
@@ -104,7 +104,7 @@ When vulnerabilities arise, use GitHub security advisories to:
104104

105105
A good advisory lists the affected versions, severity, patch status, and CVE references. Use GitHub’s built-in workflow to manage and publish advisories efficiently.
106106

107-
## Enabling Secure Software Development and Ensuring Compliance
107+
## Enabling secure software development and ensuring compliance
108108

109109
Each policy is designed to balance security and usability, offering options that range from minimal restrictions to highly controlled environments.
110110
The table below provides an overview of various security policies categorized by their level of control.
@@ -115,7 +115,7 @@ The table below provides an overview of various security policies categorized by
115115
| **Moderate Control** (Enforced Rules) | Required branch protection; Commit signing; Org-wide security policies; Monitoring webhooks | Teams needing governance with developer autonomy |
116116
| **High Control** (Strict Compliance & Governance) | Enforce SAML SSO & 2FA; Restrict visibility & forking; Mandatory PR approvals; Prevent force pushes; CI/CD security checks | Organizations with strict compliance requirements (e.g., SOC 2, ISO 27001) |
117117

118-
### Key Security and Compliance Features in GitHub Enterprise
118+
### Key security and compliance features in GitHub Enterprise
119119

120120
1. Secure Code Development
121121
- **Code Scanning (GHAS):** Automatically detect vulnerabilities via CodeQL.
@@ -130,16 +130,16 @@ The table below provides an overview of various security policies categorized by
130130
- **Restrict Repository Visibility:** Control who can view, fork, or clone.
131131
- **Fine-Grained Access Control:** Assign roles per team or project.
132132

133-
### When to Use Different Security and Compliance Profiles
133+
### When to use different security and compliance profiles
134134
- **Startups & Agile Teams:** Moderate control with branch protection, Dependabot, and secret scanning.
135135
- **Enterprises & Regulated Industries:** High control with SAML SSO, audit logging, security rulesets, and strict repo controls.
136136
- **Open Source Projects:** Low to moderate control with code scanning, dependency updates, and community guidance.
137137

138-
## Defining Organization and Enterprise Policies
138+
## Defining Organization and Enterprise policies
139139

140140
Organization policies and enterprise policies set governance, access, and workflow rules to ensure security and compliance.
141141

142-
### Key Aspects
142+
### Key aspects
143143
1. **Security & Access Control:** SAML SSO, 2FA, RBAC, repo visibility.
144144
2. **Compliance & Governance:** Audit logging, branch protection, commit signing.
145145
3. **Development Workflow & Automation:** PR approvals, security rulesets, Actions policies.

learn-pr/github/manage-sensitive-data-security-policies/includes/3-scrub-sensitive-data-from-repository.md

Lines changed: 13 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,8 @@
1-
<!--Manage sensitive data and security policies in GitHub-->
2-
31
In this unit, you’ll learn how to create and manage rulesets, and understand the advantages they offer over traditional protection rules.
42

53
As a GitHub administrator, you need granular control over who can push, delete, or rename branches and tags. **Repository rulesets** let you bundle multiple rules under a single name, apply them to selected branches or tags, and toggle them on or off without deleting them. They complement existing branch- and tag-protection rules, giving you a unified, layered approach to repository security.
64

7-
## What Are Repository Rulesets?
5+
## What are repository Rulesets?
86

97
A **ruleset** is a named collection of rules that apply to one or more branches or tags in your repository.
108

@@ -14,7 +12,7 @@ A **ruleset** is a named collection of rules that apply to one or more branches
1412

1513
For example, a ruleset for your `feature/*` branches can require signed commits and block force pushes for everyone except admins. You can also import existing tag-protection rules into a ruleset to reuse your current settings.
1614

17-
## Comparing Rulesets, Branch Protection, and Protected Tags
15+
## Comparing Rulesets, branch protection, and protected tags
1816

1917
| Capability | Protection Rules | Rulesets |
2018
|----------------------------------------------|------------------|----------------------|
@@ -28,7 +26,7 @@ For example, a ruleset for your `feature/*` branches can require signed commits
2826
- **Statuses:** Enable, disable, or evaluate (test) rulesets without deletion.
2927
- **Transparency:** Developers and auditors can view active rulesets with read access, without admin rights.
3028

31-
## Creating Your First Ruleset
29+
## Creating your first Ruleset
3230

3331
1. On GitHub.com, navigate to **Settings > Code and automation > Rules > Rulesets**.
3432
2. Click **New ruleset**, then select **Branch** or **Tag**.
@@ -42,14 +40,14 @@ For example, a ruleset for your `feature/*` branches can require signed commits
4240
> [!TIP]
4341
> For release branches (`release/*`), require two successful status checks and block force pushes to enforce stability.
4442
45-
## Managing and Editing Rulesets
43+
## Managing and editing Rulesets
4644

4745
- **View active rulesets:** On the *Rulesets* page, see which sets target a given branch or tag.
4846
- **Edit a ruleset:** Click its name, adjust rules or targets, then **Save changes**.
4947
- **Toggle status:** Enable or disable a ruleset without deleting it.
5048
- **Delete:** Remove obsolete rulesets when they’re no longer needed.
5149

52-
## Available Rules
50+
## Available rules
5351

5452
Repository rulesets support many of the same protections as branch and tag protection:
5553

@@ -64,7 +62,7 @@ Common examples:
6462
> [!TIP]
6563
> Enforce your CI/CD pipeline by requiring key workflows as status checks before merges.
6664
67-
## Layering Rulesets and Protections
65+
## Layering Rulesets and protections
6866

6967
GitHub aggregates all applicable rules—branch protection, tag protection, and multiple rulesets—and applies the most restrictive setting.
7068

@@ -74,47 +72,47 @@ GitHub aggregates all applicable rules—branch protection, tag protection, and
7472

7573
**Outcome:** Pull requests need three reviews, and commits must be both signed and linear.
7674

77-
## Impacts of Policy and Ruleset Choices in GitHub Enterprise
75+
## Impacts of policy and Ruleset choices in GitHub Enterprise
7876

7977
Your policies and rulesets affect security, compliance, developer experience, and operational efficiency. Finding the right balance between control and flexibility is essential.
8078

81-
### Security and Compliance Enforcement
79+
### Security and compliance enforcement
8280

8381
| **Pros** | **Cons** |
8482
|------------------------------|------------------------|
8583
| SAML SSO & 2FA enforced by rulesets prevent unauthorized access. | Blocking forks or enforcing lengthy approval chains can frustrate developers. |
8684
| Branch protections ensure every code change is reviewed. | Manual security checks increase administrative overhead. |
8785
| Audit-logging rulesets support SOC 2 and ISO 27001 compliance. | |
8886

89-
### Developer Productivity and Workflow Efficiency
87+
### Developer productivity and workflow efficiency
9088

9189
| **Pros** | **Cons** |
9290
|--------------------------|-------------------------|
9391
| Automated checks (Dependabot, Code Scanning) reduce manual work. | Strict approval policies slow fast-moving teams. |
9492
| Security rulesets automate compliance without manual steps. | Blocking force pushes can complicate emergency hotfixes. |
9593
| Flexible protections (e.g., reviews only on critical branches) maintain agility. | |
9694

97-
### Governance and Access Control
95+
### Governance and access control
9896

9997
| **Pros** | **Cons** |
10098
|-----------------------|---------------------------|
10199
| Visibility rules prevent accidental exposure of private code. | Over-restricting access can create collaboration bottlenecks. |
102100
| Fine-grained permissions ensure proper access levels. | Blocking forks in open-source projects hinders contributions. |
103101
| Fork restrictions reduce intellectual property risks. | |
104102

105-
### CI/CD and Automation Impact
103+
### CI/CD and automation impact
106104

107105
| **Pros** | **Cons** |
108106
|-----------------------|---------------------------|
109107
| Requiring status checks ensures code is validated before deployment. | Strict CI approvals can slow down deployments. |
110108
| Integrating GitHub Actions with rulesets enforces compliance automatically. | Blocking third-party Actions limits automation options. |
111109
| Built-in Code Scanning and Dependency Management embed security into pipelines. | |
112110

113-
## GitHub Audit Log APIs for Investigating Missing Assets
111+
## GitHub audit log APIs for investigating missing assets
114112

115113
Audit logs provide visibility into events such as repository deletions or member removals. Use REST or GraphQL to query and remediate.
116114

117-
### Steps to Troubleshoot Missing Assets
115+
### Steps to troubleshoot missing assets
118116

119117
1. **Identify the asset:** (e.g., `repository.deleted`).
120118
2. **Query the Audit Log API (REST):**

learn-pr/github/manage-sensitive-data-security-policies/includes/4-report-log.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ You can access the audit log through GitHub.com, GitHub Enterprise Server, or Gi
55
> [!TIP]
66
> Suppose a critical repository vanished overnight. You’ll use the audit logs to pinpoint the deletion event and restore continuity.
77
8-
## What Are Log Records?
8+
## What are Log Records?
99

1010
Your organization’s audit log records actions taken by organization members. Available to organization owners, the log provides information about actions that affect the organization, including:
1111

@@ -18,7 +18,7 @@ Your organization’s audit log records actions taken by organization members. A
1818
> [!NOTE]
1919
> Logs are retained for up to 90 days in GitHub Enterprise Cloud (120 days via GraphQL on Enterprise Server).
2020
21-
## Viewing and Exporting Audit Logs via the GitHub UI
21+
## Viewing and exporting Audit Logs via the GitHub UI
2222

2323
1. On GitHub.com, navigate to your organization’s **Settings > Audit log**.
2424
2. Use the **Filters** field to narrow results by qualifier (actor, repo, action, date).
@@ -66,7 +66,7 @@ query {
6666
}
6767
```
6868

69-
## Investigating Missing Assets
69+
## Investigating missing assets
7070

7171
To recover or audit missing resources like repositories or teams:
7272

@@ -93,36 +93,36 @@ query {
9393
}
9494
```
9595

96-
## Use Cases for Audit Logs
96+
## Use cases for Audit Logs
9797

9898
- **Security incidents:** Trace unauthorized access or data exfiltration.
9999
- **Compliance audits:** Demonstrate policy enforcement (SOC 2, ISO 27001).
100100
- **Operational troubleshooting:** Diagnose CI/CD failures or permission errors.
101101
- **Access monitoring:** Review API token usage and SSH/Git activity.
102102

103-
## Security & Compliance
103+
## Security and compliance
104104

105105
- **Data Retention:** 90 days on Enterprise Cloud; 120 days on Enterprise Server.
106106
- **Access Control:** Only owners and security managers can view logs.
107107
- **IP Logging:** Records source IP to detect suspicious access.
108108
- **GDPR & Regional Compliance:** Meets data-handling requirements.
109109

110-
## Audit Log Streaming
110+
## Audit Log streaming
111111

112112
Stream logs in real time to SIEM platforms (Splunk, Datadog) for long-term storage:
113113

114114
1. Go to **Settings > Audit log**.
115115
2. Under **Streaming**, configure a destination (AWS S3, Azure Event Hubs).
116116
3. Verify events arrive in your SIEM.
117117

118-
## Additional Audit Log Types
118+
## Additional Audit Log types
119119

120120
- **Git Activity Log:** Tracks pushes, pulls, merges (`phrase=git.push`).
121121
- **API Activity Log:** Tracks REST/GraphQL requests (`phrase=api.request`).
122122
- **Enterprise Managed Users (EMU):** Includes `user.login`, `repository.permissions_updated`, `repository.forked`.
123123
- **Token Usage:** Filter by `phrase=token` to identify compromised credentials.
124124

125-
## Key Security Features of a GitHub Repository
125+
## Key security features of a GitHub Repository
126126

127127
- **SECURITY.md:** Define reporting process and supported versions.
128128
- **Branch Protection:** Enforce reviews, status checks, and commit signing.
@@ -133,7 +133,7 @@ Stream logs in real time to SIEM platforms (Splunk, Datadog) for long-term stora
133133
- **Dependency Graph:** Visualize and audit dependencies.
134134
- **2FA & RBAC:** Enforce strong authentication and least privilege.
135135

136-
## API Access and Integrations
136+
## API access and integrations
137137

138138
| **Token Type** | **Description** |
139139
| ------------------------- | --------------------------------------------------------------------- |

0 commit comments

Comments
 (0)