Skip to content

chore(iii-directory): deprecate in favor of directory (final v1.0.1)#294

Open
guibeira wants to merge 1 commit into
mainfrom
chore/iii-directory-deprecation
Open

chore(iii-directory): deprecate in favor of directory (final v1.0.1)#294
guibeira wants to merge 1 commit into
mainfrom
chore/iii-directory-deprecation

Conversation

@guibeira

@guibeira guibeira commented Jun 19, 2026

Copy link
Copy Markdown
Collaborator

What

Flag the iii-directory worker as deprecated so users migrate to directory (the renamed worker, see #266) before the rename lands. Should merge before #266.

Changes

  • Startup banner — deprecation WARN at boot (skipped in --manifest mode so machine output stays clean), pointing users to iii worker add directory. Version is read dynamically from CARGO_PKG_VERSION.
  • README — deprecation > [!WARNING] notice at the top.
  • Registry description — flagged [DEPRECATED — renamed to directory; final iii-directory release] in iii.worker.yaml (surfaces in registry / console / iii worker info).

No manual version bump — the Create Tag workflow bumps the manifest and cuts the final iii-directory release. No functional/API change (the namespace was already directory::*).

Startup output

WARN iii_directory: DEPRECATED: `iii-directory` is now `directory`. v1.0.0 is the FINAL release under the `iii-directory` name and will receive no further updates. Migrate to the `directory` worker: `iii worker add directory`.

(the version shown reflects whatever the Create Tag release cuts)

Verification

  • cargo fmt --check ✓ · cargo build ✓ · 249 unit + 44/44 BDD ✓
  • validate_worker.py EXIT=0 ✓
  • startup banner confirmed by running the binary ✓

Release

After merge: run Create Tag (worker=iii-directory, bump=patch) → cuts the final release; then merge #266.

Summary by CodeRabbit

  • Documentation

    • Added deprecation notice: iii-directory has been renamed to directory. This is the final release under the old name. Users are instructed to migrate using iii worker add directory. The public API namespace remains unchanged.
  • Chores

    • Added startup deprecation warning for end-users.
    • Updated manifest metadata to reflect the deprecation.

@vercel

vercel Bot commented Jun 19, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
workers Ready Ready Preview, Comment Jun 19, 2026 1:00pm

Request Review

@coderabbitai

coderabbitai Bot commented Jun 19, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 9619cc9c-3eb3-4d4a-b666-d365c007a584

📥 Commits

Reviewing files that changed from the base of the PR and between 4e9a274 and 311ddc3.

📒 Files selected for processing (3)
  • iii-directory/README.md
  • iii-directory/iii.worker.yaml
  • iii-directory/src/main.rs

📝 Walkthrough

Walkthrough

Deprecation notices for the iii-directory package (renamed to directory) are added in three places: a markdown warning banner in the README, a prepended deprecation note in the iii.worker.yaml manifest description, and a startup tracing::warn! banner in main.rs that is skipped when running in --manifest mode.

Changes

iii-directory Deprecation Notices

Layer / File(s) Summary
Deprecation notices across docs, manifest, and runtime
iii-directory/README.md, iii-directory/iii.worker.yaml, iii-directory/src/main.rs
README gets a top-of-file warning banner with migration instructions and API-namespace clarification; manifest description is prepended with a final-release deprecation note; main.rs emits a tracing::warn! banner at startup (skipped in --manifest mode) that includes the package version from CARGO_PKG_VERSION and directs users to run iii worker add directory.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Suggested reviewers

  • sergiofilhowz

Poem

🐇 A name must change, the old must go,
iii-directory waves its final bow.
A warn! at startup, a README too,
"Run iii worker add directory," it says to you.
The namespace stays the same, don't fret —
Just hop along, no breaking sweat! 🌿

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately summarizes the main change—deprecating the iii-directory worker in favor of directory—and includes the version context; it is specific, concise, and clearly conveys the primary purpose of the changeset.
Docstring Coverage ✅ Passed Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch chore/iii-directory-deprecation

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@github-actions

github-actions Bot commented Jun 19, 2026

Copy link
Copy Markdown
Contributor

skill-check — worker

0 verified, 22 skipped (no docs/).

Layer Result
structure
vale
ai
render

Four for four. Nicely done.

iii-directory has been renamed to directory. Flag the worker as
deprecated so users migrate before the rename lands:

- emit a deprecation WARN at startup (skipped in --manifest mode),
  pointing users to `iii worker add directory`; version is read
  dynamically from CARGO_PKG_VERSION
- add a deprecation notice to the top of the README
- flag the registry description as [DEPRECATED]

No version bump here — the Create Tag workflow bumps the manifest and
cuts the final iii-directory release. No functional/API change (the
function namespace was already directory::*).
@guibeira guibeira force-pushed the chore/iii-directory-deprecation branch from 2ffe790 to 311ddc3 Compare June 19, 2026 13:00
@guibeira guibeira marked this pull request as ready for review June 19, 2026 13:01
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.

1 participant