Documentation Update for First Run ➔ gh-cache Branch, cache_key File, and JSON Escaping Guidance
Chưa có ai nhận issue này.
Đánh giá
- Độ khó
- 3/5
- Thời gian dự kiến
- 1-2 ngày
- Mức phù hợp với người mới
- 45/100
- Loại issue
- Tài liệu
- Độ rõ ràng
- Khá rõ ràng
- Mức độ hoạt động
- Đình trệ
- Công nghệ
- github-actions
- Lĩnh vực
- ci-cd, documentation
Hướng nghiên cứu
Trước tiên, hãy xem xét action.yml và thiết lập cache_key của workflow, sau đó xác định nơi các yêu cầu cho lần chạy đầu tiên được ghi lại. Ghi lại việc tạo branch gh-cache và tệp cache tương ứng, đồng thời xác minh rằng đầu ra của báo cáo xử lý các dấu ngoặc kép HTML mà không khiến workflow thoát với mã 2.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Mô tả
Great tool! It works for me now. However, I ran into a few undocumented setup issues during the first run that caused the workflow to exit with code 2.
1️⃣ Missing gh-cache branch
The first run failed with:
Branch
gh-cachedoes not exist
Creating a branch named gh-cache resolved this.
2️⃣ Missing cache file matching cache_key
Next error on report:
cache-key-valuenot found in cache
Creating and pushing an empty file onto the gh-cache branch whose name matches the cache_key value in the workflow YAML fixed this issue.
3️⃣ JSON escaping issue in action.yml file in codebase:
Final error in report:
The line echo "issues=$issues" >> "$GITHUB_OUTPUT" fails whenever HTML contains quotations. This likely happens due to the line trying to echo out unescaped quotes.
Proposed fix:
issues_escaped=$(echo "$issues" | jq -c . | sed 's/%/%25/g; s/\r/%0D/g; s/\n/%0A/g')
echo "issues=$issues_escaped" >> "$GITHUB_OUTPUT"
- Ngôn ngữ chính
- TypeScript
- Star
- 374
- Fork
- 42
- Merge trung bình
- 1 ngày 13 giờ
- Pull request đã merge (30 ngày)
- 7
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/accessibility-scanner
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 68/100
github/accessibility-scanner#264 ·
-
Độ khó 3/5 1-2 ngày Mức phù hợp với người mới 48/100
github/accessibility-scanner#260 ·
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 50/100
github/accessibility-scanner#259 ·
-
Configurable issue labels Đang mở
Độ khó 4/5 3-5 ngày Mức phù hợp với người mới 58/100
github/accessibility-scanner#245 ·
-
Sitemap Support Đang mở
Độ khó 5/5 Hơn một tuần Mức phù hợp với người mới 35/100
github/accessibility-scanner#244 ·
Tất cả issue của github/accessibility-scanner
Issue tương tự
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 75/100
vercel-labs/just-bash#464 ·
-
looksLikeSlug() is ASCII-only, so non-Latin entity slugs (e.g. Korean) skip exact match and collapse Đang mở
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 75/100
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 65/100
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 65/100
-
Độ khó 1/5 Dưới một giờ Mức phù hợp với người mới 90/100
TanStack/tanstack.com#1293 ·