Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove old or abandoned 3rd party play modules from module directory #11129

Merged
merged 4 commits into from Feb 10, 2022

Conversation

Max-AR
Copy link
Member

@Max-AR Max-AR commented Jan 28, 2022

Pull Request Checklist

Purpose

Remove old or abandoned modules from the modules directory.

Anything that had no release or any activity in 4 or more years has been removed from the 2.8 documentation.


* **Website (docs, sample):** <https://github.com/schaloner/deadbolt-2>
* **Short description:** Deadbolt is an authorization mechanism for defining access rights to certain controller methods or parts of a view using a simple AND/OR/NOT syntax

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actually deadbolt 2 is not dead. There are versions compatibly with Play 2.8 for Scala (https://github.com/schaloner/deadbolt-2-scala) and Java (https://github.com/schaloner/deadbolt-2-java). (I know that because I released that versions since the original author asked me if I want to take over because of lack of time)

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cheers, I had no idea. Let me update this.

@mkurz
Copy link
Member

mkurz commented Jan 28, 2022

Just thinking out loud: Would it make sense to not remove that old modules but instead put them into an section e.g. "archived" or "unmaintained". Not sure if that's worth it, but maybe if someone wants to write a module (s)he could do that based on an existing old one, e.g. by forking it.

@Max-AR
Copy link
Member Author

Max-AR commented Jan 28, 2022

Just thinking out loud: Would it make sense to not remove that old modules but instead put them into an section e.g. "archived" or "unmaintained". Not sure if that's worth it, but maybe if someone wants to write a module (s)he could do that based on an existing old one, e.g. by forking it.

Yeah sure, it is a softer approach than just removing them, there are some useful ideas in there that still support ~2.6 or so. I'll add them at the bottom.

@ihostage
Copy link
Member

ihostage commented Jan 28, 2022

@mkurz Absolutely. You read my mind Matthias! I think we should keep links to plugins for users can are going to find them. And if plugins don't maintain, users just can fork them.

@Max-AR Max-AR changed the title Remove old or abandoned 3rd party play modules from module direcotry Remove old or abandoned 3rd party play modules from module directory Jan 28, 2022
@gmethvin
Copy link
Member

We should add a note indicating that we don't recommend using the unmaintained libraries, though. In particular I'd be concerned they could have unpatched security vulnerabilities.

@Max-AR
Copy link
Member Author

Max-AR commented Jan 30, 2022

@gmethvin What wording would you like under the heading? I was thinking;

"These are modules that support older versions of play that are currently unmaintained and may contain security vulnerabilities. These are examples of functionality that have extended play in the past."

@gmethvin
Copy link
Member

gmethvin commented Jan 30, 2022

How about something like: "These libraries are no longer maintained, so they may not support recent Play releases, and may also contain unpatched bugs and security vulnerabilities. You might find them useful as examples, but you should avoid relying on them unless you fully understand what they are doing and are willing to fork them to fix issues yourself."

* **Short description:** Google's HTML Compressor for Play 2.

### Memcached Plugin

* **Website:** <https://github.com/mumoshu/play2-memcached>
* **Short description:** Provides a memcached based cache implementation
* **Short description:** Provides a memcached based cache implementation. Support up to play 2.6.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is not correct. play2-memcached does support Play 2.8. In its README it says "For Play 2.6.x and newer..." which just means starting with version 2.6, including 2.7 and 2.8.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for picking that up, I must have misread what the readme was saying. Thanks!

* **Website:** <https://www.silhouette.rocks/>
* **Documentation:** <https://www.silhouette.rocks/docs/>
* **Website:** <https://silhouette.readme.io/>
* **Documentation:** <https://silhouette.readme.io/docs>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The GitHub repo this website (https://github.com/mohiva/play-silhouette) is archived:

This repository is not longer maintained. All the related resources like the documentation and the forum will be closed.

However:
@honeycomb-cheesecake already is working on a fork (even thought GitHub doesn't show it as one) here: https://github.com/honeycomb-cheesecake/play-silhouette
I think we should replace the entry with the fork.

Copy link
Member Author

@Max-AR Max-AR Jan 30, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's right! The new readme.io is where the new documentation is. I've added the github link as well!

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah ok, however the GitHub link on the top of the readme page still links to the mohiva repo...

Copy link
Member Author

@Max-AR Max-AR Jan 30, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ahh I didn't realize, thanks for pointing that out. I raised an issue

playframework/play-silhouette#19

@Max-AR
Copy link
Member Author

Max-AR commented Feb 8, 2022

Were we happy to merge this? Was there anything else I needed to look at?

Copy link
Member

@mkurz mkurz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Were we happy to merge this?

I think so. Thanks!

@mkurz mkurz merged commit e17d130 into playframework:2.8.x Feb 10, 2022
@mkurz
Copy link
Member

mkurz commented Feb 10, 2022

@Mergifyio backport master

@mergify
Copy link
Contributor

mergify bot commented Feb 10, 2022

backport master

❌ No backport have been created

  • Backport to branch master failed: Git reported the following error:
fatal: couldn't find remote ref master

@mkurz
Copy link
Member

mkurz commented Feb 10, 2022

@Mergifyio backport main

@mergify
Copy link
Contributor

mergify bot commented Feb 10, 2022

backport main

✅ Backports have been created

@mkurz
Copy link
Member

mkurz commented Feb 10, 2022

@Mergifyio backport main

mkurz added a commit that referenced this pull request Feb 11, 2022
Remove old or abandoned 3rd party play modules from module directory (backport #11129)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants