Add documentation for simplesaml versions with this module's versions (README)

Created on 30 April 2024, about 2 months ago

Problem/Motivation

Normally, when people want to upgrade to Drupal 10 (like myself), people look for a version of the module that works with both Drupal 9 and 10 ideally, this way the upgrade goes smoothly and nothing breaks.

This is not possible with this module.

Issue is simplesaml version 1.19 is needed for Drupal 9, 2.1 for Drupal 10 so there is no clear documentation of this important note in the readme file or on the initial project https://www.drupal.org/project/simplesamlphp_auth β†’ page.

I had to find it through the other tickets in obscure comment in https://www.drupal.org/project/simplesamlphp_auth/issues/3349278 πŸ“Œ 4.0.0-alpha1 release compatible with D10/Symfony6 Fixed comment 132. Digging while trying to figure out why the simplesaml wouldn't work with Drupal.

Steps to reproduce

Follow the readme in the module and it has in the /vendor/simplesamlphp folder the 1.19 version. BUT* many people like myself have upgraded to php version 8.1 (not in php7.4 anymore to prepare for d10). So things wouldn't install (like doing composer update in the simplesamlphp wouldn't install because required phpunit 7.5 (assumed was on php7.4).

Proposed resolution

Make clear either in README or somewhere clear about things like this please. Otherwise an innocent soul will feel like an idiot when nothing works when trying to upgrade, and will feel like they're banging their head against a wall. Let people know that they'll need to completely uninstall simplesamlphp_auth when going from Drupal 9 to 10 and then reinstall the module fresh and reconfigure it (when the underlying simplesaml has been updated to version 2.1). I'm writing this ticket in case some other poor soul is banging their head trying to get this to work for an afternoon of work or so and just hits dead ends. Other than that grateful for this module and the maintainers, we rely on it.

Remaining tasks

User interface changes

API changes

Data model changes

πŸ’¬ Support request
Status

Needs review

Version

4.0

Component

Documentation

Created by

Live updates comments and jobs are added and updated live.
Sign in to follow issues

Merge Requests

Comments & Activities

Production build 0.69.0 2024