Contrib.social

Automated Drupal 11 compatibility fixes for styleguide

Open on Drupal.org →
Created on 25 March 2024, 8 months ago
Updated 31 August 2024, 3 months ago

Problem/Motivation

Hello project maintainers,

This is an automated issue to help make this module compatible with Drupal 11.

Changes will periodically be added to this issue that remove deprecated API uses. To stop further changes from being posted, change the status to anything other than Active, Needs review, Needs work or Reviewed and tested by the community. Alternatively, you can remove the "ProjectUpdateBotD11" tag from the issue to stop the bot from posting updates.

The changes will be posted by the Project Update Bot → official user account. This account will not receive any issue credit contributions for itself or any company.

Proposed resolution

You have a few options for how to use this issue:

  1. Accept automated changes until this issue is closed

    If this issue is left open (status of Active, Needs review, Needs work or Reviewed and tested by the community) and the "ProjectUpdateBotD11" tag is left on this issue, new changes will be posted periodically if new deprecation fixes are needed.

    As the Drupal Rector project improves and is able to fix more deprecated API uses, the changes posted here will cover more of the deprecated API uses in the module.

    Patches and/or merge requests posted by others are ignored by the bot, and general human interactions in the issue do not stop the bot from posting updates, so feel free to use this issue to refine bot changes. The bot will still post new changes then if there is a change in the new generated patch compared to the changes that the bot posted last. Those changes are then up to humans to integrate.

  2. Leave open but stop new automated changes.

    If you want to use this issue as a starting point to remove deprecated API uses but then don't want new automated changes, remove the "ProjectUpdateBotD11" tag from the issue and use it like any other issue (the status does not matter then). If you want to receive automated changes again, add back the "ProjectUpdateBotD11" tag.

  3. Close it and don't use it

    If the maintainers of this project don't find this issue useful, they can close this issue (any status besides Active, Needs review, Needs work and Reviewed and tested by the community) and no more automated changes will be posted here.

    If the issue is reopened, then new automated changes will be posted.

    If you are using another issue(s) to work on Drupal 11 compatibility it would be very useful to other contributors to add those issues as "Related issues" when closing this issue.

Remaining tasks

Using the patches

  1. Apply the latest patch in the comments by Project Update Bot → or human contributors that made it better.
  2. Thoroughly test the patch. These patches are automatically generated so they haven't been tested manually or automatically.
  3. Provide feedback about how the testing went. If you can improve the patch, post an updated patch here.

Using the merge request

  1. Review the merge request and test it.
  2. Thoroughly test the changes. These changes are automatically generated so they haven't been tested manually or automatically.
  3. Provide feedback about how the testing went. If you can improve the merge request, create a new branch and merge request and work from there.

Warning: The 'project-update-bot-only' branch will always be overwritten. Do not work in that branch!

Providing feedback

If there are problems with one of the changes posted by the Project Update Bot → , such as it does not correctly replace a deprecation, you can file an issue in the Drupal Rector issue queue → . For other issues with the bot, for instance if the issue summary created by the bot is unclear, use the Project analysis issue queue → .

📌 Task
Status

RTBC

Version

2.0

Component

Code

Created by

Project Update Bot

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

Merge Requests

Comments & Activities

  • Issue created by @Project Update Bot
  • Comment 8 months ago →
    Project Update Bot

    This is an automated patch generated using Upgrade Status and Drupal Rector. Please see the issue summary for more details. A merge request (MR) is also openend and updated.

    It is important that any automated tests available are run and that you manually test the changes.

    Drupal 11 Compatibility

    According to the Upgrade Status module → these changes make this module compatible with Drupal 11! 🎉
    Therefore these changes update the info.yml file for Drupal 11 compatibility.

    Leaving this issue open, even after committing the current patch or merging the MR, will allow the Project Update Bot → to post additional Drupal 11 compatibility fixes as they become available in Drupal Rector.

    Debug information

    Bot run #11-127659

    These packages were used to generate the fixes:

    1. drupal/upgrade_status: 4.1.0
    2. mglaman/phpstan-drupal: 1.2.9
    3. palantirnet/drupal-rector: 0.20.1
  • Merge request !15Automated Project Update Bot fixes → (Open) created by Project Update Bot
  • Status changed to RTBC 3 months ago
  • Comment 3 months ago →
    🇯🇵Japan kazuko.murata

    The MR works in the local development environment on Drupal 11.0.0.
    I have attached a screenshot of the page.

  • Comment 3 months ago →
    🇭🇰Hong Kong hswong3i

    Apply this MR for D11 now with:

    ...
    "repositories": {
        "https://packages.drupal.org/8": {
            "canonical": false,
            "type": "composer",
            "url": "https://packages.drupal.org/8"
        },
        "https://drupal.org/node/3434813": {
            "canonical": false,
            "type": "vcs",
            "url": "https://git.drupalcode.org/issue/styleguide-3434813.git"
        },
    },
...
    "require": {
        "drupal/styleguide": "dev-project-update-bot-only",
    }
...
  • First commit to issue fork.
  • Comment about 2 months ago →
    🇺🇸United States dcam

    I removed the drupal/core requirement from the new composer.json file. Previously the documentation on adding a composer.json file specified that it's better to not define drupal/core as a dependency. But I just discovered that information was removed earlier this month, see https://www.drupal.org/node/2514612/revisions/view/13628499/13705720 → . Still, it's unnecessary and it can be a pain for someone who is updating modules.

    I also removed compatibility for unsupported versions of Core, which has been my practice in the modules that I maintain.

  • Comment about 2 months ago →
    🇭🇰Hong Kong hswong3i

    @dcam with your changes the PR now couldn't install with composer...

    $ sudo -E composer update -n --ignore-platform-reqs
Gathering patches for root package.
Loading composer repositories with package information
                                                      
Skipped branch project-update-bot-only, "dde82c4462415a5b82679b994e448f246034fd9a:composer.json" does not contain valid JSON
Parse error on line 7:
...roject/styleguide",}
---------------------^
Expected: 'STRING' - It appears you have an extra trailing comma


In VcsRepository.php line 421:
                                                                                                             
  No valid composer.json was found in any branch or tag of https://git.drupalcode.org/issue/styleguide-3434  
  813.git, could not load a package from it.
  • Pipeline finished with Failed
    about 2 months ago
    Total: 150s
    #295513
  • Comment about 2 months ago →
    🇺🇸United States dcam

    Sorry about that. It was a hastily-made in the web IDE. I should know better.

  • First commit to issue fork.
  • Comment about 1 month ago →
    🇮🇳India ankitv18

    I saw minimum Drupal version is 10.3 so removed previous phpunit variables.
    If D9 support is required then please do add back those variables for executing the phpunit on previous versions.

contrib.social Blog FAQ Discussions
Production build 0.71.5 2024