Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

[workshop-sync] workshop/20-persistent-memory.md: `ttl` is not a valid cache-memory field, and the "loaded N items" log message is fabricated

Đã đóng Phù hợp với người mới
  • Có gì không ổn?
#4,243 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 1 ngày

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
76/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, markdown
Lĩnh vực
documentation

Hướng nghiên cứu

Đọc workshop/20-persistent-memory.md và workshop/side-quest-20-01-memory-patterns.md, sau đó so sánh hướng dẫn về bộ nhớ cache trong các tệp này với tài liệu về bộ nhớ cache được tham chiếu. Cập nhật các mô tả ttl không hợp lệ và xóa các bước kiểm tra thông điệp log bịa đặt, thay bằng hướng dẫn thực tế về bước khôi phục. Hoàn tất khi cả hai tệp workshop mô tả chính xác việc lưu giữ và xác minh.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

documentation

Workshop file reviewed

workshop/20-persistent-memory.md

Problem 1: ttl field does not exist

The step tells learners to configure cache-memory like this:

tools:
  cache-memory:
    key: daily-status-seen-issues
    ttl: 7d

And documents the field:

ttl: 7d | How long to keep cached data without a refresh. After 7 days of no runs the cache expires and the agent starts fresh.

This is incorrect. The live gh-aw reference docs (docs/src/content/docs/reference/cache-memory.md in github/gh-aw) show the real advanced-configuration schema is:

tools:
  cache-memory:
    key: custom-memory-${{ github.repository_owner }}
    retention-days: 30  # 1-90 days; controls uploaded artifact retention only
    allowed-extensions: [".json", ".txt", ".md"]

There is no ttl field anywhere in the docs (confirmed via grep -i ttl against the fetched reference, zero matches). The closest real field is retention-days, and the docs explicitly warn it "controls only uploaded artifact retention; it does not extend cache lifetime." GitHub Actions cache natively evicts unused entries after 7 days — that eviction isn't configurable per-workflow via a ttl-style key at all.

Problem 2: fabricated log message format

The step tells learners to verify behavior by looking for specific log lines:

confirm it contains cache-memory: loaded 0 items
find cache-memory: loaded N items

No such log string exists. Inspecting this repo's own compiled workflows (e.g. .github/workflows/curriculum-evaluator.lock.yml), the actual generated steps are named things like "Restore cache-memory file share data", "Setup cache-memory git repository", and "Commit cache-memory changes" — there is no "loaded N items" message anywhere in the gh-aw reference docs or compiled lock files.

Current correct syntax

Per https://github.github.com/gh-aw/reference/cache-memory/:

tools:
  cache-memory:
    key: daily-status-seen-issues
    retention-days: 30

(retention-days affects uploaded artifact retention only, 1–90 days; it is not a TTL/expiry control.)

Suggested fix

  1. Replace ttl: 7d with retention-days: <n> (and rewrite the "What each field does" table row to correctly describe it as controlling artifact retention, not cache expiry).
  2. Remove or replace the "cache-memory: loaded 0 items" / "loaded N items" verification instructions with guidance to inspect the actual "Restore cache-memory file share data" step output in the Actions run log, since no such literal string is produced by gh-aw.

This also affects the identical cache-memory field table duplicated in workshop/side-quest-20-01-memory-patterns.md, which should be checked/fixed in the same pass since it shares the same incorrect ttl field and table.

gh-aw release referenced: v0.89.21 (unchanged). Reference: https://github.github.com/gh-aw/reference/cache-memory/.

Generated by 🔍 Workshop Sync Check · copilot · auto · 151.5 AIC · ⌖ 5.52 AIC · ⊞ 9.2K · ◷

  • expires on Oct 7, 2026, 4:50 AM UTC
Ngôn ngữ chính
JavaScript
Star
55
Fork
36
Merge trung bình
2 ngày 8 giờ
Pull request đã merge (30 ngày)
17

Chuẩn bị môi trường

Mở trong Codespaces

Khởi chạy dev container của dự án ngay trên trình duyệt, bằng tài khoản GitHub của bạn.

  • Không có Dockerfile hay tệp Docker Compose
  • Không có mẫu pull request
  • Không có hướng dẫn đóng góp

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. 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.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của githubnext/gh-aw-workshop

Tất cả issue của githubnext/gh-aw-workshop

Issue tương tự

Thêm issue về JavaScript

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.