Bring plugin back online

[acelaya]

Relates to https://github.com/hypothesis/product-backlog/issues/1527

This is the reason the plugin was closed, and the steps to follow to bring it back:

Reason

The email associated with the plugins owner's user account bounced. As such, all plugins associated with the account were closed, because we do require your email to be functional.

What to do next

• Make sure the email on the user account is valid
• If the email is a group mail or mailing list, make sure it can receive email from external domains or non-members (Google changed their defaults in 2019 due to GDPR laws)
• If the email forwards, check all addresses to make sure they're valid and do not forward bounces
• If the ownership of the plugin is in doubt, let us know what accounts are supposed to have access and be the official owners so we can transfer them appropriately
• You must update the plugin readme to confirm it is compatible with the current release of WordPress. This is to ensure people can actually find your plugin.
• Perform a full security and guideline check of your own work. Look for sanitization, remote loading of content, and any other minor bug.
• Update all the code and upload it to SVN.
• Reply to this email that you are ready for a review

[acelaya]

Steps to follow:

• [x] Update project dependencies -> https://github.com/hypothesis/wp-hypothesis/pull/41
• [x] Migrate from travis to GitHub actions for CI and publishing -> https://github.com/hypothesis/wp-hypothesis/pull/41
• [x] Try to set-up a dev environment which provides a wordpress instance (maybe through docker compose?) -> https://github.com/hypothesis/wp-hypothesis/pull/42
• [x] Add a Makefile -> https://github.com/hypothesis/wp-hypothesis/pull/45
• [x] Test project on a WordPress 6.x instance and see if everything works -> It works! (https://github.com/hypothesis/wp-hypothesis/pull/42)
• [x] Automate plugin publishing -> https://github.com/hypothesis/wp-hypothesis/pull/44

Nice to have:

• Add some tests
• Find an opinionated code formatting tool, like prettier in the JS world
• Add a static analysis tool like PHPStan

[acelaya]

I have already published a new version using the new automated GitHub workflow.

I requested a new review to the WordPress plugins team, and will follow-up with more details as soon as they come back to us.

[SteelWagstaff]

Thanks for your work in reviving this @acelaya. We require the hypothesis WordPress plugin in our bedrocks at Pressbooks. Because the plugin was deactivated at WordPress at org, the mirror at wpackagist has been closed and it's not picking up your latest releases: https://wpackagist.org/search?q=hypothesis&type=any&search=

I'm hopeful that reactivating the plugin on WordPress.org will be enough to get the mirror back up and working.

In the meantime, however, would you have any interest in registering the plugin directly with packagist.org? The process is pretty simple and the GitHub repo already has the required composer.json file. See "Publishing Packages" instructions here: https://packagist.org/. That would allow us to simply run composer require hypothesis/hypothesis to manage the plugin as a dependency, indepedently of whether or not the wordpress.org listing is active and the wpackagist service is mirroring all tagged releases.

I could do this myself as it is a public repo, but it would then list me in packagist as a maintainer of the project, which is a bit misleading.

[acelaya]

In the meantime, however, would you have any interest in registering the plugin directly with packagist.org

This definitely makes sense. People managing their WordPress installations/deployments with composer would definitely benefit from it. I'll try to get it published there today.

Although, now that I look at the package name, it probably needs to be renamed to hypothesis/hypothesis-wp-plugin or something in those lines. The hypothesis/hypothesis name is too "top level", so to speak, and might be needed for other packages eventually.

[acelaya]

@SteelWagstaff you can find the plugin in packagist now with the package name hypothesis/wp-hypothesis https://packagist.org/packages/hypothesis/wp-hypothesis

[SteelWagstaff]

Amazing -- thanks!

[acelaya]

The plugin has been enabled again by the plugins team. I have also requested the previous owner to transfer ownership to us.

[acelaya]

Confirming wpackagist has started to pick up the new updates now that the plugin is listed again