Problem/Motivation

Hello project maintainers,

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

To read more about this effort by the Drupal Association, please read: The project update bot is being refreshed to support Drupal 10 readiness of contributed projects

Patches will periodically be added to this issue that remove Drupal 10 deprecated API uses. To stop further patches 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 "ProjectUpdateBotD10" tag from the issue to stop the bot from posting updates.

The patches 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 patches 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 "ProjectUpdateBotD10" tag is left on this issue, new patches 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 patches 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 patches. The bot will still post new patches then if there is a change in the new generated patch compared to the patch that the bot posted last. Those changes are then up to humans to integrate.

  2. Leave open but stop new automated patches.

    If you want to use this issue as a starting point to remove deprecated API uses but then don't want new automated patches, remove the "ProjectUpdateBotD10" tag from the issue and use it like any other issue (the status does not matter then). If you want to receive automated patches again, add back the "ProjectUpdateBotD10" 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 patches will be posted here.

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

    If you are using another issue(s) to work on Drupal 10 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.

Providing feedback

If there are problems with one of the patches 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.

CommentFileSizeAuthor
#20 credit-checkbox.png181.12 KBdrugan
#15 Screen Shot 2022-11-18 at 1.40.46 PM.png1.25 MBankithashetty
#15 interdiff_3289247_4-15.txt7.09 KBankithashetty
#15 3289247-15.patch10.19 KBankithashetty
#12 readmehelp.1.x-dev.rector.patch1.89 KBproject update bot
#12 interdiff-last-bot.6675709.txt302 bytesproject update bot
#11 readmehelp.1.x-dev.rector.patch1.69 KBproject update bot
#11 interdiff-last-bot.6663830.txt419 bytesproject update bot
#8 After patch readme (1).png1.01 MBAamir M
#8 After patch readme.png60.44 KBAamir M
#8 Before patch readme.png66.07 KBAamir M
#8 Patch readme.png178.46 KBAamir M
#6 Screenshot from 2022-07-29 11-31-19.png15.2 KBomkar-pd
#4 d10-compatibility-3289247-4.patch4.43 KBomkar-pd
#3 readmehelp.1.x-dev.rector.patch2.07 KBproject update bot
#3 interdiff-last-bot.6644813.txt419 bytesproject update bot
#2 readmehelp.1.x-dev.rector.patch1.69 KBproject update bot

Comments

Project Update Bot created an issue. See original summary.

project update bot’s picture

project update bot commented
Status: Active » Needs review
StatusFileSize
new readmehelp.1.x-dev.rector.patch1.69 KB

This is an automated patch generated by Drupal Rector. Please see the issue summary for more details.

It is important that any automated tests available are run with this patch and that you manually test this patch.

Drupal 10 Compatibility

According to the Upgrade Status module, even with this patch, this module is not yet compatible with Drupal 10.

Currently Drupal Rector, version 0.12.0, cannot fix all Drupal 10 compatibility problems.

This patch does not update the info.yml file for Drupal 10 compatibility.

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

Debug info

Bot run #127

This patch was created using these packages:

  1. mglaman/phpstan-drupal: 1.1.9
  2. palantirnet/drupal-rector: 0.12.0
project update bot’s picture

project update bot commented
StatusFileSize
new interdiff-last-bot.6644813.txt419 bytes
new readmehelp.1.x-dev.rector.patch2.07 KB

This is an automated patch generated by Drupal Rector. Please see the issue summary for more details.

It is important that any automated tests available are run with this patch and that you manually test this patch.

Drupal 10 Compatibility

According to the Upgrade Status module this patch makes this module compatible with Drupal 10! 🎉
This patch updates the info.yml file for Drupal 10 compatibility.

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

Debug info

Bot run #139

This patch was created using these packages:

  1. mglaman/phpstan-drupal: 1.1.24
  2. palantirnet/drupal-rector: 0.13.0
omkar-pd’s picture

omkar-pd commented
Issue summary: View changes
StatusFileSize
new d10-compatibility-3289247-4.patch4.43 KB

The above patch does not solve all the problems, providing a new patch. also solved

You have requested a non-existent parameter 'app.root

which was not picked by upgrade status module but got the error when i tested the module on d10 instance.

omkar-pd’s picture

omkar-pd commented
Issue tags: +Drupal 10 porting day
omkar-pd’s picture

omkar-pd commented
StatusFileSize
new Screenshot from 2022-07-29 11-31-19.png15.2 KB

Upgrade status results after scanning the module with provided patch.

Aamir M’s picture

Aamir M commented
Assigned: Unassigned » Aamir M
Aamir M’s picture

Aamir M commented
Assigned: Aamir M » Unassigned
StatusFileSize
new Patch readme.png178.46 KB
new Before patch readme.png66.07 KB
new After patch readme.png60.44 KB
new After patch readme (1).png1.01 MB

Verified patch #4 on Drupal 10.0.x and 10.1.x. Patch applied successfully and looks good to me.
The module can be installed after applying the patch.
Can be moved to RTBC
RTBC+1

drugan’s picture

drugan commented
Status: Needs review » Needs work

Hi, guys!

Thanks for contribution. Please add to your patch all the following fixes so phpstan will not complain at least at --level 0:

test.me ~$ php ./bin/phpstan analyze --level 0 web/modules/contrib/readmehelp
Note: Using configuration file /home/uladmin/public_html/ts-ink.ee/phpstan.neon.
 9/9 [▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓] 100%

 ------ ------------------------------------------------------------------------------ 
  Line   src/Controller/ReadmeHelpController.php                                       
 ------ ------------------------------------------------------------------------------ 
  18     \Drupal calls should be avoided in classes, use dependency injection instead  
  29     \Drupal calls should be avoided in classes, use dependency injection instead  
 ------ ------------------------------------------------------------------------------ 

 ------ ------------------------------------------------------------------------------ 
  Line   src/Plugin/Filter/ReadmehelpMarkdown.php                                      
 ------ ------------------------------------------------------------------------------ 
  80     \Drupal calls should be avoided in classes, use dependency injection instead  
 ------ ------------------------------------------------------------------------------ 

 ------ ------------------------------------------------------------------------------ 
  Line   src/Plugin/HelpSection/ReadmeHookHelpSection.php                              
 ------ ------------------------------------------------------------------------------ 
  31     \Drupal calls should be avoided in classes, use dependency injection instead  
 ------ ------------------------------------------------------------------------------ 

 ------ ------------------------------------------------------------------------------------------------------------------------------------- 
  Line   tests/src/Functional/ReadmeHelpTest.php                                                                                              
 ------ ------------------------------------------------------------------------------------------------------------------------------------- 
  12     Drupal\Tests\BrowserTestBase::$defaultTheme is required. See https://www.drupal.org/node/3083055, which includes recommendations on  
         which theme to use.                                                                                                                  
 ------ ------------------------------------------------------------------------------------------------------------------------------------- 

                                                                                                                        
 [ERROR] Found 5 errors
kristen pol’s picture

kristen pol
she/her
Primary language English
Location Santa Cruz, CA, USA
commented

Thanks everyone for participating in porting day!

@drugan Thank you for your detailed report on remaining deprecations that need to be addressed.

project update bot’s picture

project update bot commented
Status: Needs work » Needs review
StatusFileSize
new interdiff-last-bot.6663830.txt419 bytes
new readmehelp.1.x-dev.rector.patch1.69 KB

This is an automated patch generated by Drupal Rector. Please see the issue summary for more details.

It is important that any automated tests available are run with this patch and that you manually test this patch.

Drupal 10 Compatibility

According to the Upgrade Status module, even with this patch, this module is not yet compatible with Drupal 10.

Currently Drupal Rector, version 0.13.0, cannot fix all Drupal 10 compatibility problems.

This patch does not update the info.yml file for Drupal 10 compatibility.

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

Debug info

Bot run #143

This patch was created using these packages:

  1. mglaman/phpstan-drupal: 1.1.25
  2. palantirnet/drupal-rector: 0.13.0
project update bot’s picture

project update bot commented
StatusFileSize
new interdiff-last-bot.6675709.txt302 bytes
new readmehelp.1.x-dev.rector.patch1.89 KB

This is an automated patch generated by Drupal Rector. Please see the issue summary for more details.

It is important that any automated tests available are run with this patch and that you manually test this patch.

Drupal 10 Compatibility

According to the Upgrade Status module, even with this patch, this module is not yet compatible with Drupal 10.

Currently Drupal Rector, version 0.13.1, cannot fix all Drupal 10 compatibility problems.

This patch does not update the info.yml file for Drupal 10 compatibility.

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

Debug info

Bot run #145

This patch was created using these packages:

  1. mglaman/phpstan-drupal: 1.1.25
  2. palantirnet/drupal-rector: 0.13.1
project update bot’s picture

project update bot commented
Issue summary: View changes

Updating bot issue summary.See #3313904: Update project bot templates for RTBC status support and human interaction tips

ankithashetty’s picture

ankithashetty
Location Karnataka, India
commented
Assigned: Unassigned » ankithashetty
Issue summary: View changes

Assigning it to myself! Working on it as a part of the D10 porting day...

Thanks!

ankithashetty’s picture

ankithashetty
Location Karnataka, India
commented
Assigned: ankithashetty » Unassigned
Issue summary: View changes
Issue tags: +Needs manual testing
StatusFileSize
new 3289247-15.patch10.19 KB
new interdiff_3289247_4-15.txt7.09 KB
new Screen Shot 2022-11-18 at 1.40.46 PM.png1.25 MB

Here is a patch for D10 compatibility addressing the changes made by the bot, in #4 and the suggestions made in #9. Attaching an interdiff as well.

Enabled the module with the patch on the D10 site, works as expected.

Thanks!

kristen pol’s picture

kristen pol
she/her
Primary language English
Location Santa Cruz, CA, USA
commented

Thanks 🙏

I just realized how cool this module is! Love to see the readmes in the UI ❤️

  • a68dd80 committed on 8.x-1.x 
    Issue #3289247 ankithashetty, omkar-pd, Aamir M: Automated Drupal 10...
drugan’s picture

drugan commented
Status: Needs review » Fixed

Thanks everyone for your contribution!

I am not sure why author is not displayed on the page despite I used the commit message from the Git command below.

Though on the module's gitlab page the author name displayed as expected:

https://git.drupalcode.org/project/readmehelp/-/tree/8.x-1.x

Please let me know if it's me who should repair this weird error.

kristen pol’s picture

kristen pol
she/her
Primary language English
Location Santa Cruz, CA, USA
commented

Thanks! Do you mean on this page? If so, you have to manually check the checkboxes and submit a comment… I recommend checking your box since you did the maintainer work :)

drugan’s picture

drugan commented
StatusFileSize
new credit-checkbox.png181.12 KB

Okay, submitting once more with the following checkboxes checked:

credit

Status: Fixed » Closed (fixed)

Automatically closed - issue fixed for 2 weeks with no activity.