Expose Crane run cadence as an installer choice and tuning guide
Chưa có ai nhận issue này.
- Ngôn ngữ chính
- Python
- Star
- 10
- Fork
- 0
- Chỉ số merge pull request
- Không có pull request nào được merge trong 30 ngày
Mô tả
Background
The githubnext/apm migration needed faster iteration than the default Crane cadence. APM locally changed the Crane workflow schedule from every 6h to every 20m so Crane could converge in hours rather than days while maintainers were actively watching.
That should not necessarily become the upstream default. It should become an explicit installation and tuning choice.
Problem
The upstream Crane workflow defaults to a fixed schedule. The README explains that users can tune cadence, and install.md asks about migration frequency, but the installed workflow still needs a clear path for applying and documenting the chosen cadence.
Different migrations need different cadences:
- Active, high-attention migration: every 20m or every 1h.
- Normal migration in a busy repository: every 6h.
- Low-risk background migration: daily or weekly.
- Multiple active migrations: cadence interacts with the scheduler because each run selects only one migration.
If the cadence is too slow, Crane appears idle and migrations take too long. If it is too fast, maintainers get too many commits and CI runs.
Proposed implementation
Update Crane installation and documentation so cadence is a first-class choice.
Implementation options:
-
In
install.md, keep the frequency prompt but make the follow-through explicit:- The agent should edit
workflows/crane.mdto seton.scheduleto the selected cadence. - Then it should run
gh aw compile crane.
- The agent should edit
-
In
README.md, add a cadence tuning section with examples:
on:
schedule: every 20m
on:
schedule: every 1h
on:
schedule: every 6h
-
Explain trade-offs:
- Faster cadence gets feedback quickly but increases CI usage and review pressure.
- Slower cadence is calmer but may make migrations look stalled.
- For multiple migrations, faster workflow cadence may still run only one selected migration per trigger.
-
Consider adding guidance to
create-migration.mdfor per-migrationschedule:frontmatter versus workflow-level cadence. Users should understand both knobs:- Workflow cadence: how often Crane wakes up.
- Migration schedule: whether a specific migration is due when Crane wakes up.
Suggested test coverage
- Documentation test or prompt test that asserts
install.mdsays to updateworkflows/crane.mdand compile after selecting cadence. - If installer automation exists, test that the selected cadence changes the workflow source before compilation.
Acceptance criteria
- A new Crane installer run asks for cadence and applies it to the workflow source.
- Documentation explains recommended cadence ranges and trade-offs.
- Documentation distinguishes workflow wake-up cadence from per-migration schedule frontmatter.
- Users can reproduce the APM-style fast loop intentionally without hand-editing undocumented workflow internals.
Provenance
This came from githubnext/apm, where changing Crane to every 20m helped the Python-to-Go migration converge much faster while humans were actively reviewing.
Hướng dẫn đóng góp
Chưa lập chỉ mục được hướng dẫn đóng góp cho kho mã nguồn này
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.
Hướng nghiên cứu
Bắt đầu với install.md và lần theo cách cadence prompt được xử lý, sau đó kiểm tra workflows/crane.md và bước gh aw compile. So sánh hướng dẫn về cadence cần có trong README.md và create-migration.md, bao gồm workflow cadence so với migration schedule frontmatter. Được xem là hoàn tất khi cadence được chọn được áp dụng trước khi biên dịch, các đánh đổi được ghi lại và các bài kiểm thử tài liệu hoặc prompt liên quan đều đạt.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Đánh giá
- Công nghệ
- github-actions
- Lĩnh vực
- devops, documentation
- Loại issue
- Tính năng
- Độ khó
- 4/5
- Thời gian dự kiến
- 3-5 ngày
- Mức độ hoạt động
- Ít trao đổi
- Độ rõ ràng
- Khá rõ ràng
- Mức phù hợp với người mới
- 58/100