Skip to content

Conversation

@CybotTM
Copy link
Member

@CybotTM CybotTM commented Nov 28, 2025

Summary

  • Create docs/MIGRATION.md with comprehensive migration documentation
  • Update README.md to link to the new migration guide with a tip callout

Migration Guide Contents

The guide covers:

Quick Start

  • Import path changes
  • go.mod updates
  • Go version requirements (1.13 → 1.25)

Behavioral Differences

Detailed before/after examples for:

Type Changes

  • EntryID: intuint64 with migration examples

New Features

  • FakeClock for deterministic testing
  • StopAndWait() convenience method
  • Timeout wrapper (with caveats)
  • Heap-based scheduling performance improvements
  • slog adapter

Practical Guidance

  • Migration checklist
  • Testing recommendations with code examples
  • Troubleshooting section for common issues

Test Plan

  • Markdown renders correctly (verified locally)
  • All internal links work
  • Code examples are syntactically correct
  • README tip callout renders properly
  • Tests pass (go test -race ./...)
  • Linter passes (golangci-lint run ./...)

Closes #73

Create docs/MIGRATION.md with detailed migration documentation:

- Quick start section with import path and go.mod changes
- Go version requirements comparison
- Behavioral differences with before/after examples:
  - TZ= parsing panic fixes (robfig#554, robfig#555)
  - Entry.Run() chain behavior fix (robfig#551)
  - DST spring-forward handling (robfig#541)
  - Step range validation (robfig#543)
  - Input length limits
- Type changes (EntryID: int -> uint64)
- New features overview (FakeClock, StopAndWait, Timeout, heap scheduling)
- Migration checklist
- Testing recommendations with code examples
- Troubleshooting section

Also update README.md to link to the comprehensive migration guide.

Closes #73
@CybotTM CybotTM merged commit c17be23 into main Nov 28, 2025
15 checks passed
@CybotTM CybotTM deleted the docs/73-migration-guide branch November 28, 2025 13:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Create migration guide from robfig/cron

2 participants