docs: update README workflow example with enhanced configuration#38
Merged
Conversation
- 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
aff84b1 to
e1ba081
Compare
🛡️ PR Quality Check Summary✅ PR Title: Passed (Length: 64/75, Format: OK). 🎉 All checks passed! |
Contributor
Author
|
@torrid-fish This pr is about docs update. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
目的
更新 README.md 中的快速開始範例,提供更完整且清晰的 GitHub Actions 工作流程配置範例,讓使用者更容易理解如何使用 org-workflows 的品質檢查功能。
方法/實作說明
主要修改:
README.md- 更新快速開始區塊的工作流程 YAML 範例關鍵實作:
branches: ['main']限制只在 main 分支的 PR 觸發檢查permissions區段,明確定義所需的權限(contents, pull-requests, issues, checks)quality-gate改為quality-checks,並新增顯示名稱 "Run Organization Quality Checks"python-version: '3.11'參數明確指定 Python 版本關聯 Issue
無關聯 Issue
附註