8000 Add UPGRADING.md: the v4 to v5 guide by irfan-dahir · Pull Request #665 · jikan-me/jikan · GitHub
[go: up one dir, main page]

Skip to content

Add UPGRADING.md: the v4 to v5 guide - #665

Merged
irfan-dahir merged 2 commits into
masterfrom
docs/upgrading-v4-to-v5
Oct 15, 2026
Merged

irfan-dahir merged 2 commits into
masterfrom
docs/upgrading-v4-to-v5

Conversation

@irfan-dahir
Copy link
Copy Markdown
Collaborator

The upgrade guide for v4 users, as the RC needs. It's linked from the readme.

How it was checked

It's not written from the changelog alone.

  • API diff. The public surface of v4.0.13 and current master were compared class by class: 4 classes and 6 methods removed, 40 classes added, 78 return types changed.
  • Side-by-side run. v4.0.13 (installed in a scratch directory) and v5 were both run against the same 85 recorded MyAnimeList pages covering the endpoints they share, and the parsed results compared field by field. 51 pages are identical. Every real difference in the other 34 is in the guide (relative dates like "6 minutes ago" move with the clock and are left out).

What it covers

Requirements (PHP 8.4.4, the Symfony libraries), the code that has to change, the getters that can now return null, results that are different, what's new, and a checklist.

It also corrected some things I'd have written wrong

  • Person::getPublishedManga() and manga related entries were broken in the v5 beta, not in v4, so they are not in the guide as "fixes".
  • AnimeParser::getModel() called twice does fail in v4 and works in v5, so that one is listed.
  • v4 genre cards, producer cards and the schedule had type and airingStart as null, not wrong values.
  • The changelog's v5.0.0 note said the public surface "removes nothing". It does remove a few classes and methods, so that sentence now points at the guide.

Depends on

Docs only: no code changes.

🤖 Generated with Claude Code

irfan-dahir and others added 2 commits October 15, 2026 21:33
Written from the real difference between v4.0.13 and v5: the public API diff
(removed classes and methods, 78 return-type changes) and a side-by-side run of
both versions on 85 recorded pages (51 identical; every other difference is in
the guide). Linked from the readme.

Also corrects the v5.0.0 changelog note that said the public surface "removes
nothing": it removes a few classes and methods and makes many getters nullable.

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
@irfan-dahir
irfan-dahir merged commit fcfcdca into master Oct 15, 2026
6 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.

1 participant

0