Decisions
Architecture decision records
Significant design decisions of bikesched, one file per decision, numbered in order, in the format of Michael Nygard (Status, Context, Decision, Consequences), see ADR 0001. Copy the template for a new one.
| ADR | Title | Status |
|---|---|---|
| 0001 | Record architecture decisions | Accepted |
| 0002 | Own SQL migrations instead of a migration framework | Accepted |
| 0003 | Implementation in internal packages, enforced by ArchUnit | Accepted |
| 0004 | Typed job and event types next to the string-based API | Accepted, renamed by 0059 |
| 0005 | Recurring jobs via schedule(Recurrence) | Accepted |
| 0006 | Text columns with length checks; messages truncated | Accepted |
| 0007 | Job history in a separate, opt-in table | Superseded by 0062 |
| 0008 | Event expiry fixed when publishing | Accepted |
| 0009 | Step writes fenced by the job’s lock | Accepted |
| 0010 | A lock token per claim instead of a version column | Accepted |
| 0011 | Received event steps store the mapped result | Superseded by 0018 |
| 0012 | Ended jobs deleted after a retention by default | Accepted |
| 0013 | Statement timeout as JDBC query timeout | Accepted |
| 0014 | Opt-in hard timeout for handlers that ignore their timeout | Accepted |
| 0015 | Snapshots published to GitHub Packages with maven-publish | Accepted |
| 0016 | Nodes claim only job types they handle | Accepted |
| 0017 | Retrying failed jobs keeps their completed steps | Accepted |
| 0018 | Event payloads copied into steps, no event handlers | Accepted |
| 0019 | Job handler annotations in their own module | Accepted |
| 0020 | Job listener SPI with Micrometer in its own module | Accepted |
| 0021 | Apache License 2.0 with a trademark policy | Accepted |
| 0022 | Spring integration in its own module | Accepted; startup migration superseded by 0039 |
| 0023 | Steps cannot be nested | Accepted, timeout handlers superseded by 0034 |
| 0024 | Cron expressions via cron-utils in their own module | Accepted |
| 0025 | Recurrence parsers in core | Accepted |
| 0026 | Durable sleep as a step without an event | Accepted |
| 0027 | Publish events from jobs as durable steps | Accepted |
| 0028 | Step kinds and plain event references | Accepted |
| 0029 | Child jobs as one step holding the outcome | Accepted |
| 0030 | Event listener reports committed publications only | Accepted |
| 0031 | Poll steps: one step for all checks | Accepted, timeout handler superseded by 0034 |
| 0032 | Waking pollers with batched notifications after the commit | Accepted |
| 0033 | Failure handlers for jobs and steps | Accepted |
| 0034 | Timeouts of event waits and polls handled by failure handlers | Accepted |
| 0035 | Website hosted on static.app instead of GitHub Pages | Superseded by 0047 |
| 0036 | Idempotency keys as columns, taken while the job exists | Accepted |
| 0037 | Postponing a job gives its attempt back | Accepted |
| 0038 | Admin UI as static files on a framework-neutral handler | Accepted, JSON handling superseded by 0040 |
| 0039 | Optional automatic schema migration with history validation | Accepted |
| 0040 | Nanojson for admin JSON with an optional shaded artifact | Accepted |
| 0041 | Nullness of the public API with JSpecify annotations | Accepted, partly superseded by 0048 |
| 0042 | Removed nodes register again under their id | Accepted, amended by 0051 |
| 0043 | Sealed types for the internal job state | Accepted |
| 0044 | Publishing events from the admin UI | Accepted |
| 0045 | Nodes in the admin UI | Accepted |
| 0046 | Scheduling jobs from the admin UI | Accepted |
| 0047 | Website hosted on Cloudflare Workers instead of static.app | Accepted |
| 0048 | Nullness checked with NullAway in the core build | Accepted |
| 0049 | Java 21 as the language baseline, built with JDK 26 | Accepted |
| 0050 | Load and failure tests in their own module, run on demand | Accepted |
| 0051 | Node names are not unique | Accepted |
| 0052 | Clean-ups delete in resuming batches | Accepted |
| 0053 | Releases cut from tags, one release branch per minor | Accepted |
| 0054 | Time-ordered ids (UUIDv7) | Accepted |
| 0055 | Byte limits for names and keys | Accepted |
| 0056 | Schema naming, column order and invariants | Accepted |
| 0057 | Steps keyed by a time-ordered id | Accepted (history part superseded by 0062) |
| 0058 | Fixed-delay recurrences and a planned run on every occurrence | Accepted |
| 0059 | Job name and job type | Accepted |
| 0060 | Data source passed to the builder | Accepted |
| 0061 | References for jobs and events | Accepted |
| 0062 | One history with actions and actors | Accepted |
| 0063 | C collation for identifiers | Accepted |