Update CheckpointID/trailer doc comments to mention ULIDs

8a72620→main·

Soph·2w ago·2 files·+5 added/-3 removed

Doc-only follow-up to the ULID understanding layer: the CheckpointID type comment and the CheckpointTrailerKey comment still described the ID as "12 hex characters." Note both supported formats (legacy 12-hex and 26-char ULID) and point at the canonical id.CheckpointPattern / Kind.

Co-Authored-By: Claude Opus 4.8 (1M context) noreply@anthropic.com

Sessions

da0a3dbefa5eView transcript

Changes

2

• cmd/entire/cli

  • checkpoint/id

    • Mid.go+3/-2

  • trailers

    • Mtrailers.go+2/-1

9 unmodified lines

10
11
12
13
14
13
14
15
16
17
18

9 unmodified lines

"regexp"
// CheckpointID is a 12-character hex identifier for checkpoints.
// It's used to link code commits to metadata on the entire/checkpoints/v1 branch.
// CheckpointID identifies a checkpoint. It comes in two formats: a legacy
// 12-character lowercase hex ID and a 26-character Crockford base32 ULID (see
// Kind / CheckpointPattern). It links code commits to their checkpoint metadata.
//
//nolint:recvcheck // UnmarshalJSON requires pointer receiver, others use value receiver - standard pattern

type CheckpointID string

Mcmd/entire/cli/checkpoint/id/id.go+3/-2

35 unmodified lines

36
37
38
39
39
40
41
42
43

35 unmodified lines

SourceRefTrailerKey = "Entire-Source-Ref"

// CheckpointTrailerKey links commits to their checkpoint metadata on entire/checkpoints/v1.
    // Format: 12 hex characters e.g. "a3b2c4d5e6f7"
    // Format: a checkpoint ID — either a legacy 12-hex ID (e.g. "a3b2c4d5e6f7")
    // or a 26-char ULID (see checkpoint/id.CheckpointPattern).
    // This trailer survives git amend and rebase operations.
    CheckpointTrailerKey = "Entire-Checkpoint"

Mcmd/entire/cli/trailers/trailers.go+2/-1