Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
96 changes: 96 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,96 @@
# dofaromg 組織設定與部署空間 | Organization Configuration & Deployment Spaces

## 🏠 這裡是什麼地方 (What is this place?)

這是 `dofaromg` 組織的 `.github` 設定倉庫,提供整個組織的預設配置和部署能力。

This is the `.github` configuration repository for the `dofaromg` organization, providing organization-wide default configurations and deployment capabilities.

**簡單來說 (In simple terms)**: 這個倉庫就像是組織的「總部設定中心」,所有屬於 dofaromg 組織的項目都會繼承這裡的配置。

## 可存取的空間與部署 (Available Spaces and Deployments)

### 🔧 社群健康檔案 (Community Health Files)
- **CODE_OF_CONDUCT.md** - 行為準則,基於 Google 開源社群指導原則
- **CONTRIBUTING.md** - 貢獻指導,包含 CLA 和程序說明
- **SECURITY.md** - 安全問題回報程序

### 🔒 安全掃描與部署 (Security Scanning & Deployment)
- **GitHub Actions Workflow**: 自動掃描 GitHub Actions 工作流程的安全問題
- **Semgrep Rules**: 包含針對 GitHub Actions 的安全規則
- **SARIF 報告**: 生成標準化安全分析結果

### 🚀 可存取的部署空間 (Accessible Deployment Spaces)

此設定倉庫管理以下部署空間和服務:

#### 1. **GitHub Actions 執行環境**
```yaml
Environment: ubuntu-latest
Container: semgrep/semgrep
Permissions:
- contents: read
- security-events: write
```

#### 2. **安全掃描服務**
- **Semgrep 掃描器**: 靜態程式碼分析
- **GitHub Security Dashboard**: 結果展示和管理
- **SARIF 報告系統**: 標準化安全報告格式

#### 3. **組織級服務**
- **Community Health Files**: 為所有倉庫提供預設的社群檔案
- **Contributor License Agreement (CLA)**: 透過 Google CLA 系統
- **Code Review Process**: 標準化的審查流程

#### 4. **自動化工作流程**
- **Pull Request 觸發**: 程式碼變更時自動檢查
- **Push 觸發**: 工作流程檔案更新時掃描
- **手動觸發**: 可隨時執行安全掃描

### 🔧 部署管理功能 (Deployment Management Features)

| 功能 Feature | 描述 Description | 狀態 Status |
|-------------|-----------------|-----------|
| 安全掃描 Security Scanning | 自動檢測 GitHub Actions 安全問題 | ✅ 已啟用 |
| 社群健康 Community Health | 提供組織級預設檔案 | ✅ 已啟用 |
| 工作流程監控 Workflow Monitoring | 持續監控部署管道 | ✅ 已啟用 |
| 報告生成 Report Generation | SARIF 格式安全報告 | ✅ 已啟用 |



## 如何使用 (How to Use)

### 對於組織成員 (For Organization Members)
1. 所有新建的倉庫會自動應用這些設定
2. 可以在個別倉庫中覆寫這些預設值
3. 安全掃描會自動運行於包含 GitHub Actions 的倉庫

### 對於管理員 (For Administrators)
1. 修改此倉庫的檔案會影響整個組織
2. 新增或更新 Semgrep 規則以改善安全檢測
3. 監控 Security Dashboard 中的掃描結果

## 設定檔案結構 (Configuration Structure)

```
.github/
├── workflows/
│ └── action_scanning.yml # 安全掃描工作流程
├── CODE_OF_CONDUCT.md # 行為準則
├── CONTRIBUTING.md # 貢獻指導
├── SECURITY.md # 安全政策
└── semgrep-rules/
└── actions/
└── pull_request_target_needs_exception.yml
```

## 支援與聯絡 (Support & Contact)

- 安全問題:請使用 https://g.co/vulnz 回報
- 一般問題:請聯絡 opensource@google.com
- 程序問題:請建立 Issue 或 Pull Request

---

*此倉庫遵循 Google 開源社群指導原則*