Skip to content

Commit 6f49a22

Browse files
committed
docs(issues): open SI-09 torrust#1821 rename torrust-tracker-clock to torrust-clock
- Move spec from drafts/ to open/ with issue number prefix 1821 - Update spec: issue number, branch, defer crates.io tasks to SI-13 - Update EPIC torrust#1669 SI-09 row with issue torrust#1821 link and open spec path
1 parent 4918ca6 commit 6f49a22

2 files changed

Lines changed: 42 additions & 48 deletions

File tree

docs/issues/open/1669-overhaul-packages/EPIC.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -215,7 +215,7 @@ Status: TODO unless noted. `SI-XX` = recommended implementation sequence number.
215215
- [x] SI-06 — [#1813](https://github.com/torrust/torrust-tracker/issues/1813) Resolve `bittorrent-tracker-core``torrust-tracker-rest-api-client` layer violation _(Rule M; prerequisite for `bittorrent-tracker-core` extraction)_
216216
- [x] SI-07 — [#1816](https://github.com/torrust/torrust-tracker/issues/1816) Align `torrust-` prefix: rename 7 tracker-specific packages to `torrust-tracker-` _(Rule U; no blockers)_
217217
- [x] SI-08 — [#1819](https://github.com/torrust/torrust-tracker/issues/1819) Rename `torrust-tracker-metrics` to `torrust-metrics` _(Rule U; no blockers)_
218-
- [ ] SI-09 — Rename `torrust-tracker-clock` to `torrust-clock` _(Rule P; no blockers)_
218+
- [ ] SI-09 — [#1821](https://github.com/torrust/torrust-tracker/issues/1821) Rename `torrust-tracker-clock` to `torrust-clock` _(Rule P; no blockers)_
219219
- [ ] SI-10 — Rename `torrust-tracker-located-error` to `torrust-located-error` _(Rule P; no blockers)_
220220
- [ ] SI-11 — Update all package READMEs _(documentation; after SI-07–SI-10; before SI-12)_
221221
- [ ] SI-12 — Extract and rename `torrust-tracker-contrib-bencode` to `torrust-bencode` _(Rule E; no blockers within this EPIC)_
@@ -235,7 +235,7 @@ Details:
235235
| SI-06 | [#1813](https://github.com/torrust/torrust-tracker/issues/1813) — Resolve `bittorrent-tracker-core``torrust-tracker-rest-api-client` layer violation | [docs/issues/closed/1813-1669-06-resolve-bittorrent-tracker-core-rest-api-layer-violation.md](../../closed/1813-1669-06-resolve-bittorrent-tracker-core-rest-api-layer-violation.md) | DONE | Rule M; stale unused dev dep removed in PR #1804; unblocks `bittorrent-tracker-core` extraction |
236236
| SI-07 | [#1816](https://github.com/torrust/torrust-tracker/issues/1816) — Align `torrust-` prefix: rename 7 tracker-specific packages to `torrust-tracker-` | [docs/issues/open/1816-1669-07-align-torrust-prefix-rename-tracker-specific-packages.md](../../open/1816-1669-07-align-torrust-prefix-rename-tracker-specific-packages.md) | DONE | Rule U; none of the 7 are published; pure workspace rename; no blockers |
237237
| SI-08 | [#1819](https://github.com/torrust/torrust-tracker/issues/1819) — Rename `torrust-tracker-metrics` to `torrust-metrics` | [docs/issues/open/1819-1669-08-rename-torrust-tracker-metrics-to-torrust-metrics.md](../../open/1819-1669-08-rename-torrust-tracker-metrics-to-torrust-metrics.md) | DONE | Rule U; not yet published; no blockers; prerequisite for SI-14 |
238-
| SI-09 | #TBD — Rename `torrust-tracker-clock` to `torrust-clock` | [docs/issues/drafts/1669-09-rename-torrust-tracker-clock-to-torrust-clock.md](../../drafts/1669-09-rename-torrust-tracker-clock-to-torrust-clock.md) | TODO | Rule P; published on crates.io; no blockers; prerequisite for SI-13 |
238+
| SI-09 | [#1821](https://github.com/torrust/torrust-tracker/issues/1821) — Rename `torrust-tracker-clock` to `torrust-clock` | [docs/issues/open/1821-1669-09-rename-torrust-tracker-clock-to-torrust-clock.md](../../open/1821-1669-09-rename-torrust-tracker-clock-to-torrust-clock.md) | TODO | Rule P; published on crates.io; no blockers; prerequisite for SI-13 |
239239
| SI-10 | #TBD — Rename `torrust-tracker-located-error` to `torrust-located-error` | [docs/issues/drafts/1669-10-rename-torrust-tracker-located-error-to-torrust-located-error.md](../../drafts/1669-10-rename-torrust-tracker-located-error-to-torrust-located-error.md) | TODO | Rule P; published on crates.io; no blockers |
240240
| SI-11 | #TBD — Update all package READMEs | [docs/issues/drafts/1669-11-update-all-package-readmes.md](../../drafts/1669-11-update-all-package-readmes.md) | TODO | Documentation; requires SI-07–SI-10; before SI-12 |
241241
| SI-12 | #TBD — Extract and rename `torrust-tracker-contrib-bencode` to `torrust-bencode` | [docs/issues/drafts/1669-12-extract-torrust-tracker-contrib-bencode-to-torrust-bencode.md](../../drafts/1669-12-extract-torrust-tracker-contrib-bencode-to-torrust-bencode.md) | TODO | Rule E; no workspace-dep blockers; Apache-2.0; one internal consumer |

docs/issues/drafts/1669-09-rename-torrust-tracker-clock-to-torrust-clock.md renamed to docs/issues/open/1821-1669-09-rename-torrust-tracker-clock-to-torrust-clock.md

Lines changed: 40 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
---
22
doc-type: issue
33
issue-type: task
4-
status: draft
4+
status: open
55
priority: p2
6-
github-issue: null
7-
spec-path: docs/issues/drafts/1669-09-rename-torrust-tracker-clock-to-torrust-clock.md
8-
branch: null
6+
github-issue: 1821
7+
spec-path: docs/issues/open/1821-1669-09-rename-torrust-tracker-clock-to-torrust-clock.md
8+
branch: 1821-rename-torrust-tracker-clock-to-torrust-clock
99
related-pr: null
10-
last-updated-utc: 2026-05-15 12:00
10+
last-updated-utc: 2026-05-21 12:00
1111
semantic-links:
1212
skill-links:
1313
- create-issue
@@ -21,7 +21,7 @@ semantic-links:
2121

2222
<!-- skill-link: create-issue -->
2323

24-
# Issue #[To be assigned] - Rename `torrust-tracker-clock` to `torrust-clock`
24+
# Issue #1821 - Rename `torrust-tracker-clock` to `torrust-clock`
2525

2626
## Goal
2727

@@ -45,8 +45,9 @@ crate's actual purpose. The rename:
4545
(see [1669-13-extract-torrust-clock-to-standalone-repo.md](1669-13-extract-torrust-clock-to-standalone-repo.md)).
4646

4747
The current crate name `torrust-tracker-clock` is **published on crates.io** (as of
48-
May 2026). The rename requires publishing the new name `torrust-clock` and handling the
49-
old published name (yank or deprecation notice).
48+
May 2026). Publishing the new name `torrust-clock` and handling the old published name
49+
(yank or deprecation notice) are **deferred to SI-13** (extract `torrust-clock` to
50+
standalone repository). This issue covers only the in-workspace rename.
5051

5152
**This issue has a prerequisite**: the `DEFAULT_TIMEOUT` constant must be moved from
5253
`torrust-tracker-configuration` to `torrust-tracker-clock` before this rename is started,
@@ -80,43 +81,35 @@ This issue is a subissue of EPIC #1669 (Overhaul: Packages).
8081
- Update prose references in `packages/AGENTS.md`, `AGENTS.md`, `docs/packages.md`, and the `clock` package
8182
`README.md`.
8283
- Verify the workspace builds and all tests pass.
83-
- Publish `torrust-clock` on crates.io.
84-
- Handle the old crates.io name `torrust-tracker-clock`: first add a deprecation notice /
85-
README update pointing to `torrust-clock`; yank all versions only after `torrust-index`
86-
migration is merged (see Companion work).
8784

8885
### Out of Scope
8986

87+
- Publishing `torrust-clock` on crates.io — deferred to SI-13.
88+
- Deprecating or yanking `torrust-tracker-clock` on crates.io — deferred to SI-13.
89+
- Updating `torrust-index` to use `torrust-clock` — deferred to SI-13; an issue will be
90+
opened on `torrust/torrust-index` once the crate is published under the new name.
9091
- Moving the crate to a separate repository — see
91-
[1669-13-extract-torrust-clock-to-standalone-repo.md](1669-13-extract-torrust-clock-to-standalone-repo.md).
92+
[1669-13-extract-torrust-clock-to-standalone-repo.md](../drafts/1669-13-extract-torrust-clock-to-standalone-repo.md).
9293
- Changes to the crate's API or behaviour.
9394

94-
### Companion work (other repositories)
95-
96-
`torrust-index` currently contains a copy of the clock code rather than a proper dependency
97-
(see Background). After `torrust-clock` is published, `torrust-index` must be updated to
98-
depend on `torrust-clock` and delete its local copy. This work happens in the
99-
`torrust/torrust-index` repository and must be completed **before** the old crates.io name
100-
`torrust-tracker-clock` is yanked. See T10.
101-
10295
## Implementation Plan
10396

10497
Status values: `TODO`, `IN_PROGRESS`, `BLOCKED`, `DONE`.
10598

106-
| ID | Status | Task | Notes / Expected Output |
107-
| --- | ------ | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------ |
108-
| T1 | TODO | Rename `name` in `packages/clock/Cargo.toml` | `name = "torrust-clock"` |
109-
| T2 | TODO | Update root `Cargo.toml` workspace dependency key | `torrust-clock = { version = ..., path = "packages/clock" }` |
110-
| T3 | TODO | Update all dependent package `Cargo.toml` files (10 packages, excluding root — see T2) | Replace `torrust-tracker-clock` key with `torrust-clock` in each |
111-
| T4 | TODO | Update Rust source `use` / path references (`torrust_tracker_clock::``torrust_clock::`) | Affects `src/`, package sources, and integration tests |
112-
| T5 | TODO | Update prose in `packages/AGENTS.md`, `AGENTS.md`, `docs/packages.md`, `packages/clock/README.md` | Crate name and any inline code snippets |
113-
| T6 | TODO | Run `cargo build --workspace` and `cargo test --workspace` | Clean build and all tests pass |
114-
| T7 | TODO | Run `linter all` | Exit code `0` |
115-
| T8 | TODO | Publish `torrust-clock` on crates.io | Successful `cargo publish -p torrust-clock` |
116-
| T9 | TODO | Add deprecation notice to `torrust-tracker-clock` on crates.io | README / description points to `torrust-clock`; do **not** yank yet |
117-
| T10 | TODO | Update `torrust-index`: replace copied clock code with `torrust-clock` dep | Companion PR in `torrust/torrust-index`; must be merged before T11 |
118-
| T11 | TODO | Yank all versions of `torrust-tracker-clock` on crates.io | All versions yanked; downstream migration (T10) must be complete first |
119-
| T12 | TODO | Update EPIC #1669 `Package Inventory` and `Desired Package State` tables | Move `torrust-clock` from `torrust-tracker-` to `torrust-`; drop `Renamed from` note |
99+
| ID | Status | Task | Notes / Expected Output |
100+
| --- | -------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------ |
101+
| T1 | TODO | Rename `name` in `packages/clock/Cargo.toml` | `name = "torrust-clock"` |
102+
| T2 | TODO | Update root `Cargo.toml` workspace dependency key | `torrust-clock = { version = ..., path = "packages/clock" }` |
103+
| T3 | TODO | Update all dependent package `Cargo.toml` files (10 packages, excluding root — see T2) | Replace `torrust-tracker-clock` key with `torrust-clock` in each |
104+
| T4 | TODO | Update Rust source `use` / path references (`torrust_tracker_clock::``torrust_clock::`) | Affects `src/`, package sources, and integration tests |
105+
| T5 | TODO | Update prose in `packages/AGENTS.md`, `AGENTS.md`, `docs/packages.md`, `packages/clock/README.md` | Crate name and any inline code snippets |
106+
| T6 | TODO | Run `cargo build --workspace` and `cargo test --workspace` | Clean build and all tests pass |
107+
| T7 | TODO | Run `linter all` | Exit code `0` |
108+
| T8 | DEFERRED | Publish `torrust-clock` on crates.io | Deferred to SI-13 |
109+
| T9 | DEFERRED | Add deprecation notice to `torrust-tracker-clock` on crates.io | Deferred to SI-13 |
110+
| T10 | DEFERRED | Update `torrust-index`: replace copied clock code with `torrust-clock` dep | Deferred to SI-13; open issue on `torrust/torrust-index` after crate is published |
111+
| T11 | DEFERRED | Yank all versions of `torrust-tracker-clock` on crates.io | Deferred to SI-13 |
112+
| T12 | TODO | Update EPIC #1669 `Package Inventory` and `Desired Package State` tables | Move `torrust-clock` from `torrust-tracker-` to `torrust-`; drop `Renamed from` note |
120113

121114
**Dependent packages to update in T3** (10 files; root `Cargo.toml` is handled in T2):
122115

@@ -135,23 +128,24 @@ Status values: `TODO`, `IN_PROGRESS`, `BLOCKED`, `DONE`.
135128

136129
### Workflow Checkpoints
137130

138-
- [ ] Spec drafted in `docs/issues/drafts/`
139-
- [ ] Spec reviewed and approved by user/maintainer
140-
- [ ] GitHub issue created and issue number added to this spec
141-
- [ ] Spec moved to `docs/issues/open/` with issue number prefix
131+
- [x] Spec drafted in `docs/issues/drafts/`
132+
- [x] Spec reviewed and approved by user/maintainer
133+
- [x] GitHub issue created and issue number added to this spec
134+
- [x] Spec moved to `docs/issues/open/` with issue number prefix
142135
- [ ] Implementation completed
143136
- [ ] Automatic verification completed (`linter all`, `cargo test --workspace`)
144137
- [ ] Manual verification scenarios executed and recorded
145138
- [ ] Acceptance criteria reviewed after implementation and updated with evidence
146-
- [ ] `torrust-clock` published on crates.io; deprecation notice added to old name
147-
- [ ] `torrust-index` migrated to `torrust-clock` (companion PR merged)
148-
- [ ] `torrust-tracker-clock` yanked on crates.io
139+
- [ ] `torrust-clock` published on crates.io; deprecation notice added to old name (deferred to SI-13)
140+
- [ ] `torrust-index` migrated to `torrust-clock` (companion PR merged) (deferred to SI-13)
141+
- [ ] `torrust-tracker-clock` yanked on crates.io (deferred to SI-13)
149142
- [ ] EPIC #1669 Active Subissues table updated to `DONE`
150143
- [ ] Issue closed and spec moved to `docs/issues/closed/`
151144

152145
### Progress Log
153146

154147
- 2026-05-15 12:00 UTC - josecelano - Spec drafted as subissue of EPIC #1669
148+
- 2026-05-21 12:00 UTC - josecelano - GitHub issue #1821 created; spec moved to `docs/issues/open/`; branch `1821-rename-torrust-tracker-clock-to-torrust-clock` created; crates.io tasks deferred to SI-13
155149

156150
## Acceptance Criteria
157151

@@ -161,10 +155,10 @@ Status values: `TODO`, `IN_PROGRESS`, `BLOCKED`, `DONE`.
161155
- [ ] `cargo build --workspace` succeeds with zero errors.
162156
- [ ] `cargo test --workspace` passes with zero failures.
163157
- [ ] `linter all` exits with code `0`.
164-
- [ ] `torrust-clock` is published and visible on crates.io.
165-
- [ ] `torrust-tracker-clock` has a deprecation notice pointing to `torrust-clock`.
166-
- [ ] `torrust-index` no longer contains a local copy of clock code; it depends on `torrust-clock`.
167-
- [ ] `torrust-tracker-clock` is yanked on crates.io (only after `torrust-index` migration is merged).
158+
- [ ] `torrust-clock` is published and visible on crates.io (deferred to SI-13).
159+
- [ ] `torrust-tracker-clock` has a deprecation notice pointing to `torrust-clock` (deferred to SI-13).
160+
- [ ] `torrust-index` no longer contains a local copy of clock code; it depends on `torrust-clock` (deferred to SI-13).
161+
- [ ] `torrust-tracker-clock` is yanked on crates.io (only after `torrust-index` migration is merged) (deferred to SI-13).
168162
- [ ] `packages/AGENTS.md`, `AGENTS.md`, `docs/packages.md`, and `packages/clock/README.md` reflect the new crate name.
169163
- [ ] EPIC #1669 `Desired Package State` table lists `torrust-clock` in the `torrust-` section.
170164

0 commit comments

Comments
 (0)