Skip to content

docs: update README workflow example with enhanced configuration#38

Merged
G36maid merged 1 commit into
mainfrom
docs/quick-start
Feb 14, 2026
Merged

docs: update README workflow example with enhanced configuration#38
G36maid merged 1 commit into
mainfrom
docs/quick-start

Conversation

@G36maid

@G36maid G36maid commented Feb 14, 2026

Copy link
Copy Markdown
Contributor

目的

更新 README.md 中的快速開始範例,提供更完整且清晰的 GitHub Actions 工作流程配置範例,讓使用者更容易理解如何使用 org-workflows 的品質檢查功能。

方法/實作說明

  • 主要修改:

    • README.md - 更新快速開始區塊的工作流程 YAML 範例
  • 關鍵實作:

    • 將工作流程名稱從 "Quality Checks" 改為更明確的 "PR Quality Checks"
    • 新增 branches: ['main'] 限制只在 main 分支的 PR 觸發檢查
    • 新增 permissions 區段,明確定義所需的權限(contents, pull-requests, issues, checks)
    • 將 job 名稱從 quality-gate 改為 quality-checks,並新增顯示名稱 "Run Organization Quality Checks"
    • 為每個檢查項目新增詳細的註解說明,包括:
      • Basic Checks - 基本 PR 檢查
      • Python Checks - Python 程式碼品質檢查,註明需要 pyproject.toml 與 ruff/mypy 配置
      • Config Checks - 設定檔語法檢查(YAML, JSON, TOML)
      • Frontend Checks - 前端程式碼品質檢查,註明需要 Prettier 配置
      • Go Checks - Go 程式碼品質檢查,註明需要 go.mod 檔案(golangci-lint 配置可選)
    • 新增 python-version: '3.11' 參數明確指定 Python 版本
    • 重新組織輸入參數的順序,將相關的檢查項目群組在一起

關聯 Issue

無關聯 Issue

附註

  • 此次變更僅影響文件內容,不影響任何工作流程邏輯
  • 後續可考慮根據使用者回饋進一步補充更多使用情境的範例

- Updated workflow name from 'Quality Checks' to 'PR Quality Checks'
- Added branches filter for main branch
- Added permissions section for proper token access
- Changed job name from 'quality-gate' to 'quality-checks'
- Added detailed inline comments for each check type
- Added explicit python-version parameter
- Updated Go checks comment with accurate requirements

docs: update README workflow example

- Updated workflow name from 'Quality Checks' to 'PR Quality Checks'
- Added branches filter for main branch
- Added permissions section for proper token access
- Changed job name from 'quality-gate' to 'quality-checks'
- Added detailed inline comments for each check type
- Added explicit python-version parameter
- Updated Go checks comment with accurate requirements"

Update README.md
@github-actions

Copy link
Copy Markdown

🛡️ PR Quality Check Summary

PR Title: Passed (Length: 64/75, Format: OK). docs: update README workflow example with enhanced configuration
Branch Name: Follows naming convention (docs/quick-start)
Commit Messages: All 1 commit(s) passed (Length, Format, Case)
Conflicts: No merge conflict markers found
YAML Files: All 12 file(s) passed validation
JSON Files: All 1 file(s) are valid
TOML Files: No TOML files found to check


🎉 All checks passed!

@G36maid

G36maid commented Feb 14, 2026

Copy link
Copy Markdown
Contributor Author

@torrid-fish This pr is about docs update.

@torrid-fish torrid-fish left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@G36maid G36maid added this pull request to the merge queue Feb 14, 2026
Merged via the queue into main with commit ca35ead Feb 14, 2026
6 checks passed
@G36maid G36maid deleted the docs/quick-start branch February 14, 2026 12:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants