Skip to content

refactor(located-error): [#1823] rename torrust-tracker-located-error to torrust-located-error#1824

Merged
josecelano merged 4 commits into
torrust:developfrom
josecelano:1823-rename-torrust-tracker-located-error-to-torrust-located-error
May 22, 2026
Merged

refactor(located-error): [#1823] rename torrust-tracker-located-error to torrust-located-error#1824
josecelano merged 4 commits into
torrust:developfrom
josecelano:1823-rename-torrust-tracker-located-error-to-torrust-located-error

Conversation

@josecelano
Copy link
Copy Markdown
Member

@josecelano josecelano commented May 21, 2026

Summary

Implements #1823: rename the Cargo crate torrust-tracker-located-errortorrust-located-error.

What changed

  • T1packages/located-error/Cargo.toml: name = "torrust-located-error"
  • T2 — N/A: no workspace-level dep existed in root Cargo.toml; all 5 dependent packages reference the crate directly
  • T3 — Dep key renamed in 5 Cargo.toml files:
    • packages/configuration/Cargo.toml
    • packages/axum-server/Cargo.toml
    • packages/http-protocol/Cargo.toml
    • packages/tracker-core/Cargo.toml
    • packages/tracker-client/Cargo.toml
  • T4 — 10 Rust source use statements updated (torrust_tracker_located_error::torrust_located_error::) across 9 files
  • T5 — Prose updated in: AGENTS.md, packages/located-error/README.md, .github/workflows/deployment.yaml, docs/release_process.md, .github/skills/dev/git-workflow/release-new-version/SKILL.md, .github/skills/dev/rust-code-quality/handle-errors-in-code/SKILL.md
  • T6/T7cargo build --workspace, cargo test --workspace, and linter all all pass

Pre-implementation analysis

The "Pre-Implementation Review: Keep vs. Delete" section in the spec records the analysis done before committing to the rename. Recommendation was Keep + rename, which was proceeded with. If a reviewer disagrees and prefers deletion, this PR can be closed and a replacement issue opened with delete-and-migrate scope.

Spec

docs/issues/open/1823-1669-10-rename-torrust-tracker-located-error-to-torrust-located-error.md

Out of scope (deferred)

  • T8: Publish torrust-located-error on crates.io
  • T9: Deprecation notice on old crates.io name
  • T10: Downstream repos migration
  • T11: Yank torrust-tracker-located-error
  • T12: Update EPIC Overhaul: packages #1669 tables

Closes #1823. Related to #1669.

…ated-error

Move SI-10 of EPIC torrust#1669 from drafts/ to open/ with the assigned GitHub

issue number, and update frontmatter (status, github-issue, spec-path,

branch, last-updated-utc).
…rror rename spec

Record pre-implementation review of whether torrust-tracker-located-error

should be kept and renamed or removed entirely. Recommendation: keep and

rename. Awaiting reviewer confirmation in the draft PR before starting T1.
@josecelano josecelano requested a review from da2ce7 May 21, 2026 18:28
…d-error to torrust-located-error

Rename Cargo crate name in packages/located-error/Cargo.toml (T1).

No workspace-level dep existed in root Cargo.toml (T2 is N/A).

Update dep keys in 5 dependent Cargo.toml files (T3):

  packages/{configuration,axum-server,http-protocol,tracker-core,tracker-client}/Cargo.toml.

Update 10 Rust source use statements from torrust_tracker_located_error::

to torrust_located_error:: across 9 files (T4).

Update prose in AGENTS.md, packages/located-error/README.md,

.github/workflows/deployment.yaml, docs/release_process.md, and

two skill files under .github/skills/ (T5).

cargo build --workspace, cargo test --workspace, and linter all all pass (T6/T7).
@josecelano josecelano changed the title docs(issues): [#1823] pre-implementation review for located-error rename (keep vs. delete) refactor(located-error): [#1823] rename torrust-tracker-located-error to torrust-located-error May 22, 2026
@josecelano josecelano marked this pull request as ready for review May 22, 2026 08:32
@josecelano josecelano requested a review from a team as a code owner May 22, 2026 08:32
Copilot AI review requested due to automatic review settings May 22, 2026 08:32
@josecelano josecelano self-assigned this May 22, 2026
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Renames the internal workspace crate torrust-tracker-located-error to the more generic torrust-located-error, updating dependency keys, Rust import paths, and related documentation/workflow references across the repository.

Changes:

  • Renamed the located-error crate package name and updated all workspace Cargo.toml dependency keys accordingly.
  • Updated Rust use paths from torrust_tracker_located_error::* to torrust_located_error::*.
  • Updated docs and release automation references to the new crate name.

Reviewed changes

Copilot reviewed 23 out of 24 changed files in this pull request and generated 2 comments.

Show a summary per file
File Description
packages/located-error/Cargo.toml Renames the crate to torrust-located-error.
packages/located-error/src/lib.rs Updates doctest import path to the new crate identifier.
packages/located-error/README.md Updates README title and docs.rs link to the new crate name.
packages/configuration/Cargo.toml Renames dependency key to torrust-located-error.
packages/configuration/src/lib.rs Updates Rust imports to torrust_located_error.
packages/axum-server/Cargo.toml Renames dependency key to torrust-located-error.
packages/axum-server/src/tsl.rs Updates Rust imports to torrust_located_error.
packages/http-protocol/Cargo.toml Renames dependency key to torrust-located-error.
packages/http-protocol/src/v1/requests/announce.rs Updates Rust imports to torrust_located_error.
packages/http-protocol/src/v1/requests/scrape.rs Updates Rust imports to torrust_located_error.
packages/tracker-core/Cargo.toml Renames dependency key to torrust-located-error.
packages/tracker-core/src/error.rs Updates Rust imports (including test module) to torrust_located_error.
packages/tracker-core/src/databases/error.rs Updates Rust imports to torrust_located_error.
packages/tracker-core/src/authentication/key/mod.rs Updates Rust imports to torrust_located_error.
packages/tracker-core/src/authentication/handler.rs Updates Rust imports to torrust_located_error.
packages/tracker-client/Cargo.toml Renames dependency key to torrust-located-error.
packages/tracker-client/src/udp/mod.rs Updates Rust imports to torrust_located_error.
Cargo.lock Replaces the lockfile entry for the old crate name with the new one.
.github/workflows/deployment.yaml Updates cargo publish target name to torrust-located-error.
docs/release_process.md Updates crates.io link to torrust-located-error.
AGENTS.md Updates package catalog entry for located-error crate name.
.github/skills/dev/rust-code-quality/handle-errors-in-code/SKILL.md Updates dependency snippet and import path to the new crate name.
.github/skills/dev/git-workflow/release-new-version/SKILL.md Updates published-crates list to the new crate name.
docs/issues/open/1823-1669-10-rename-torrust-tracker-located-error-to-torrust-located-error.md Updates the spec metadata/progress to reflect the rename work.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread .github/skills/dev/rust-code-quality/handle-errors-in-code/SKILL.md Outdated
Comment thread .github/workflows/deployment.yaml Outdated
@codecov
Copy link
Copy Markdown

codecov Bot commented May 22, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 77.65%. Comparing base (4c6dee4) to head (df16e1a).

Additional details and impacted files
@@             Coverage Diff             @@
##           develop    #1824      +/-   ##
===========================================
- Coverage    77.70%   77.65%   -0.06%     
===========================================
  Files          379      379              
  Lines        28604    28604              
  Branches     28604    28604              
===========================================
- Hits         22227    22212      -15     
+ Misses        6072     6070       -2     
- Partials       305      322      +17     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

…rrust-located-error

Move cargo publish -p torrust-located-error to the top of the deployment

workflow so it is published before its 5 dependents (bittorrent-http-tracker-protocol,

bittorrent-tracker-client, bittorrent-tracker-core, torrust-tracker-axum-server,

torrust-tracker-configuration).

Fix handle-errors-in-code skill snippet: replace { workspace = true } with

{ version = "3.0.0-develop", path = "../located-error" } since no [workspace.dependencies]

section exists in the root Cargo.toml.

Addresses Copilot review comments on PR torrust#1824.
@josecelano
Copy link
Copy Markdown
Member Author

ACK df16e1a

@josecelano josecelano merged commit 4ebf332 into torrust:develop May 22, 2026
27 checks passed
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.

Rename torrust-tracker-located-error to torrust-located-error

2 participants