Skip to content

Document the 5.6.x track and where its patches come from - #95

Open
mutumbakato wants to merge 2 commits into
masterfrom
kato/readme-note-master-locked-on-5-6
Open

Document the 5.6.x track and where its patches come from#95
mutumbakato wants to merge 2 commits into
masterfrom
kato/readme-note-master-locked-on-5-6

Conversation

@mutumbakato

@mutumbakato mutumbakato commented Aug 4, 2026

Copy link
Copy Markdown
Contributor

From 6.0 onwards the Flutter SDK is published to pub.dev only — users reach the native SDK APIs through the bindings API, so this repository no longer needs to carry the plugin source for new releases. master stays on 5.6.x, and pre-6.0 updates land here directly via PRs. The nightly branch continues to receive updates.

5.6.x keeps receiving patch releases here through December 2026, for projects that aren't ready to adopt the bindings API. Those patches are published to this repository only.

Changes

  • Adds a note under the intro: this branch tracks 5.6.x and does not track 6.0 and later, 5.6.x gets patches here through December 2026, and those patches are repository-only. Points at pub.dev, the changelog, and the SDK 6 migration guide.
  • Switches the installation snippet from nutrient_flutter: any to a Git dependency pinned to a release tag. any resolves to 6.0.0, while every instruction around it is 5.6.x-era — minSdkVersion 21 vs 24, no Flutter 3.44.6 requirement, no bindings entry point, no direct platform-package dependencies. Anyone following this README with any would hit a build failure that looks like an SDK bug.
  • A pub.dev constraint can't deliver a patch either: ^5.6.0 resolves to 5.6.1 and stays there, since new patches don't go to pub.dev. It's kept as the documented option for anyone who doesn't need patches.

Notes

  • Verified the Git dependency target: tag 5.6.1 resolves on this repository, the repo root is the nutrient_flutter package, and its pubspec.yaml at that tag reads version: 5.6.1.
  • The corresponding website change is PSPDFKit/nutrient-website#5422, which documents the same split in the SDK 6 migration guide, the downloads page, and the Flutter getting started guide.

Nutrient Flutter SDK 6.0 and later are published to pub.dev only. The native
SDK APIs are reachable through the bindings API, so this repository no longer
needs to carry the plugin source for new releases, and master stays on 5.6.x.

Also pin the installation snippet to ^5.6.0. It read `nutrient_flutter: any`,
which resolves to 6.0.0 once that is on pub.dev, while the surrounding setup
instructions here are 5.6.x-era — different minimum Android API level, Flutter
version, and dependency shape. Following this README with `any` would fail to
build.

The nightly branch continues to receive updates.
@mutumbakato mutumbakato self-assigned this Aug 4, 2026
@mutumbakato mutumbakato changed the title Note that this branch is locked on 5.6.x Note that master tracks 5.6.x and pin the install to ^5.6.0 Aug 12, 2026
@mutumbakato
mutumbakato marked this pull request as ready for review August 12, 2026 17:58
New 5.6.x patch releases are published to this repository only, so a
pub.dev constraint cannot deliver one. `^5.6.0` resolves to 5.6.1 and
stays there, which meant this README told readers to consume 5.6.x from
the one channel that will not carry its fixes.

- Recommends a Git dependency pinned to a release tag, and keeps
  `^5.6.0` as the pub.dev option for anyone who does not need patches.
- Reframes "no longer updated for newer releases", which read as
  abandoned, and states the December 2026 patch window.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
@mutumbakato mutumbakato changed the title Note that master tracks 5.6.x and pin the install to ^5.6.0 Document the 5.6.x track and where its patches come from Aug 12, 2026
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