Add a note for copilot-setup-steps.yml and using with a merge queue
Chưa có ai nhận issue này.
Đánh giá
- Độ khó
- 2/5
- Thời gian dự kiến
- 1-3 giờ
- Mức phù hợp với người mới
- 84/100
- Loại issue
- Tài liệu
- Độ rõ ràng
- Đặc tả rõ ràng
- Mức độ hoạt động
- Sôi nổi
- Công nghệ
- github-actions
- Lĩnh vực
- ci-cd, documentation
Hướng nghiên cứu
Bắt đầu với bài viết được liên kết về các bước thiết lập Copilot và tìm ví dụ copilot-setup-steps.yml hiện có. Xem xét cách các trigger push và pull_request của ví dụ này hoạt động với các nhánh merge queue, sau đó cập nhật ví dụ hoặc thêm ghi chú inline bằng cấu hình được đề xuất. Được xem là hoàn tất khi tài liệu cảnh báo về các lần chạy merge queue không cần thiết, đồng thời vẫn duy trì việc kiểm thử thủ công và xác thực thay đổi.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Mô tả
Code of Conduct
- I have read and agree to the GitHub Docs project's Code of Conduct
What article on docs.github.com is affected?
What part(s) of the article would you like to see updated?
Somewhat related to #42379
In the github docs, it says that you can add the following to you copilot-setup-steps.yml file:
name: "Copilot Setup Steps"
## Background
# Automatically run the setup steps when they are changed to allow for easy validation, and
# allow manual testing through the repository's "Actions" tab
on:
workflow_dispatch:
push:
paths:
- .github/workflows/copilot-setup-steps.yml
pull_request:
paths:
- .github/workflows/copilot-setup-steps.yml
While this works, I've found that if you use a merge queue then using the above configuration results in your workflow running every time a PR is added to the merge queue. We are use the larger, custom image GitHub hosted runners and this results in unnecessary runs & costs.
github/copilot-sdk was the first public GitHub repo I found that had the same issue(although this one is just using default ubuntu-latest runners). It helped me figure out that behavior wasn't unique to our setup
Proposed Content Update
I'd like to update the docs to either add an inline comment with commented out code or add a little inline note about if using a merge queue. This is what ended up working for us:
name: "Copilot Setup Steps"
# Automatically run when changed so setup issues surface immediately.
# Also allows manual testing via the "Actions" tab.
on:
workflow_dispatch:
push:
branches-ignore:
- 'gh-readonly-queue/**'
paths:
- .github/workflows/copilot-setup-steps.yml
pull_request:
branches:
- main
paths:
- .github/workflows/copilot-setup-steps.yml
Additional information
No response
- Ngôn ngữ chính
- TypeScript
- Star
- 20.9k
- Fork
- 68.8k
- Merge trung bình
- 15 giờ 4 phút
- Pull request đã merge (30 ngày)
- 103
Hướng dẫn đóng góp
Bắt đầu từ đâu
- Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
- Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
- Fork repository và làm thay đổi trên một nhánh.
- Mở pull request có tham chiếu số hiệu của issue.
Issue khác của github/docs
-
builder persona content
Độ khó 1/5 Dưới một giờ Mức phù hợp với người mới 90/100
-
localization
Độ khó 2/5 1-2 ngày Mức phù hợp với người mới 72/100
-
builder persona
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 82/100
-
content localization
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 78/100
-
content localization
Độ khó 1/5 Dưới một giờ Mức phù hợp với người mới 92/100
Issue tương tự
-
S: triage
Độ khó 1/5 Dưới một giờ Mức phù hợp với người mới 85/100
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 76/100
-
fix(errors): EHOSTUNREACH from a happy-eyeballs connect is reported as a resolver error (STAMP-80) Đang mở
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 90/100
snapshot-labs/stamp#666 ·
-
fix(api): prevent leaderboard SSE heartbeat from starting after disconnect during initial load Đang mởbug
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 75/100
GauravKarakoti/SecureFlow#1070 · 1 bình luận ·
-
feature:Languages/Translations good first issue ready Web
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 72/100
digitalfabrik/integreat-app#4394 ·