[promptless-for-oss]

Open in Promptless

Description

Plugin developers who read the 7.1 docs need to know which documented APIs change or go away in Mautic 8 before they upgrade. This PR adds a .. warning:: notice next to each affected passage in docs/plugins, linked to UPGRADE-8.0.md.

Changes:

• database.rst: notices on ClassMetadataBuilder::addContact() (removed in Mautic 8) and on createManyToMany()/createOneToMany() (they return Doctrine's association builders).
• mvc.rst: notice that Mautic deprecated Mautic\CoreBundle\Controller\FormController in Mautic 2.3 and removes it in Mautic 8 (use AbstractFormController).
• permissions.rst: notices in Using permissions (mautic.security becomes CorePermissions::class), Creating custom permissions (Mautic 8 deprecates the $params constructor argument), and Permission aliases (getSynonym() overrides need the : array return type).
• cache.rst: notice in Configuration (mautic.cache.adapter.* service IDs become adapter class names).
• docs/links/mautic_8_upgrade.py: link file with one :xref: target, Mautic 8 UPGRADE-8.0.md, which points to UPGRADE-8.0.md in the Mautic repository. Every Mautic 8 notice PR on the 7.x branches ships an identical copy, so whichever merges first adds it.

Revision note: following the maintainer's direction that UPGRADE-8.0.md is the one place for Mautic 8 upgrade steps, every notice in this PR follows the approved #834 pattern and links only to UPGRADE-8.0.md. The link file is trimmed to that one entry, so the notices no longer depend on sections of the 8.0 Plugin upgrade page. The cache adapter notice is shortened to the change and the upgrade pointer.

Review pass (from #821): the FormController notice now names the class and uses the past tense for the 2.3 deprecation, matching the 7.0 PR. None of the other notices covers a deprecation that starts in Mautic 7.0, so none needs a 'since Mautic 7.0' line.

Validation: Vale reports no new alerts on the changed lines. A local Sphinx 9.1 build of this branch reports no new warnings compared with the base branch. The PR no longer depends on any 8.0 PR, so it can merge in any order.

Review pass (@adiati98, line 64 of database.rst): the addContact() notice now names the removed method instead of 'this': 'Mautic removes addContact() in Mautic 8.' The same fix is applied to the 7.0, 7.1, 7.2, and 7.3 versions of this PR (#821, #824, #827, #830).

Linked issue

None

Screenshots or screen recordings

N/A

Trigger Events

• Deep Analysis: Task: Address the deprecations that Mautic 8 introduces in the developer docs (mautic/developer-documentation-new). This covers three things:...

[coderabbitai]

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

Run configuration

• Source mode: Auto
• Repository: Unavailable
• Branch: Unavailable
• File: No configuration file from this repository applied
• Commit: Unavailable
• Layers: defaults
• Review profile: CHILL
• Plan: Advanced
• Run ID: f95aed3f-04f0-494c-9b1e-b9d07a0a69d6

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

• 🔍 Trigger review

• Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

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

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands.}

[adiati98]

/aside @escopecz can you please help to review this PR? I want to know if the wordings here are okay to inform folks of what they will expect in Mautic 8.

If this example is acceptable, then I can confidently merge PRs that hold this kind of information.

TIA! ✨