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

Update list to include SS4 modules and modules in CWP 2.0 recipes #3

Conversation

raissanorth
Copy link

@raissanorth raissanorth commented Jun 1, 2018

Also:

  • introduce two new boolean attributes, scrutinizer and addons, to aid in displaying the table of modules
  • delete uncommented code.
  • link to addons page, rather than GitHub
  • update links of repos that moved from GitLab to GitHub.
  • update references to silverstripe-australia, since renaming to symbiote
  • retrieve badges directly from Scrutinizer where possible and display custom shield badge, where not possible

Fixes https://github.com/silverstripeltd/cc-issues/issues/124

Copy link

@robbieaverill robbieaverill left a comment

Choose a reason for hiding this comment

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

LGTM. There's some weird indentation in the JS file. @chillu would you mind taking a look over these amendments?

"type": "supported-module"
},
{
"github": "bringyourownideas\/silverstripe-composer-update-checker",
Copy link
Member

Choose a reason for hiding this comment

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

Should those just be supported dependencies, with silverstripe-maintanence as the supported module? This would allow us to provide the same functionality in a different way

"type": "supported-dependency"
},
{
"github": "silverstripe-australia\/silverstripe-gridfieldextensions",
Copy link
Member

Choose a reason for hiding this comment

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

It's a bit hard to read this diff with both edits and ordering changes in the same commit (gridfieldextensions is reintroduced later on in the diff)

"type": "supported-module"
},
{
"github": "silverstripe\/silverstripe-dms-cart",
Copy link
Member

Choose a reason for hiding this comment

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

I guess we don't have a way to qualify "supported under CWP 1.x", right? It'll become clear by the lack of available CWP 2.x compatible releases

Copy link
Author

Choose a reason for hiding this comment

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

We could, but we'd have to add yet another attribute to the list.

Choose a reason for hiding this comment

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

We thought about doing this with semver constraints and dates and stuff but decided to go with a boolean 😆

"type": "supported-module"
},
{
"github": "silverstripe\/silverstripe-graphql-devtools",
Copy link
Member

Choose a reason for hiding this comment

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

Why does this need to be supported?

modules.json Outdated
"type": "supported-module"
},
{
"github": "silverstripe\/silverstripe-moduleratings",
Copy link
Member

Choose a reason for hiding this comment

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

I don't this silverstripe-moduleratings or silverstripe-moduleratings-plugin need to be declared as supported

modules.json Outdated
"type": "supported-module"
},
{
"github": "silverstripe-australia\/silverstripe-multivaluefield",
"github": "silverstripe\/silverstripe-mssql",
Copy link
Member

Choose a reason for hiding this comment

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

Nope, please don't add this.

@chillu
Copy link
Member

chillu commented Jun 4, 2018

This is adding a whole bunch of stuff to supported modules - some of them are obvious, some are judgement calls which we should discuss (e.g. mssql). That's hard to do with this diff. @raissanorth Can you please list the modules which have been added and removed here? Alternatively, separate commits for ordering changes and add/remove changes :)

@raissanorth
Copy link
Author

raissanorth commented Jun 5, 2018

Sorry about that. Given that this repo is used to generate the list of commercially supported modules on https://www.silverstripe.org/software/addons/silverstripe-commercially-supported-module-list/, I'll just focus on the changes made to the latest version of that page.

Modules added:

bringyourownideas/silverstripe-maintenance			
bringyourownideas/silverstripe-composer-update-checker			
bringyourownideas/silverstripe-composer-security-checker	
composer/installers				
cwp/cwp-recipe-cms	
cwp/cwp-recipe-core		
dnadesign/silverstripe-elemental			
dnadesign/silverstripe-elemental-subsites			
dnadesign/silverstripe-elemental-userforms	
cwp/cwp-installer	
lekoala/silverstripe-debugbar				
silverstripe/activedirectory				
silverstripe/admin	
silverstripe/asset-admin		
silverstripe/assets	
silverstripe/behat-extension				
silverstripe/config	
silverstripe/controllerpolicy		
silverstripe/elemental-blocks		
silverstripe/eslint-config			
silverstripe/gridfieldqueuedexport	
silverstripe/moduleratings		
silverstripe/moduleratings-plugin			
silverstripe/mssql
silverstripe/postgresql			
silverstripe/raygun
silverstripe/realme		
silverstripe/recipe-cms				
silverstripe/recipe-content-blocks		
silverstripe/recipe-core
silverstripe/recipe-plugin
silverstripe/upgrader		
silverstripe/versioned			
silverstripe/webpack-config			
silverstripe-themes/simple	
tractorcow/classproxy			
tractorcow/silverstripe-proxy-db		

Modules Renamed:

silverstripe/cwp-recipe-search into cwp/cwp-recipe-search

Included Modules That Were Already Listed on silverstripe.org:

colymba/gridfield-bulk-editing-tools	
cwp/agency-extensions	
cwp/cwp		
cwp/cwp-core	
cwp/cwp-pdfexport	
cwp/cwp-recipe-basic
cwp/cwp-recipe-basic-dev
cwp/cwp-recipe-blog	
cwp/cwp-search	
cwp/starter-theme	
cwp/watea-theme
cwp-themes/default	
hafriedlander/phockito	
hafriedlander/silverstripe-phockito	
silverstripe/akismet	
silverstripe/auditor		
silverstripe/blog	
silverstripe/campaign-admin			
silverstripe/cms	
silverstripe/comment-notifications			
silverstripe/comments		
silverstripe/content-widget	
silverstripe/contentreview	
silverstripe/crontask			
silverstripe/dms			
silverstripe/dms-cart			
silverstripe/documentconverter		
silverstripe/environmentcheck		
silverstripe/errorpage				
silverstripe/externallinks			
silverstripe/framework		
silverstripe/fulltextsearch		
silverstripe/graphql		
silverstripe/graphql-devtool			
silverstripe/html5	
silverstripe/hybridsessions		
silverstripe/iframe	
silverstripe/installer	
silverstripe/ldap	
silverstripe/lumberjack	
silverstripe/mimevalidator		
silverstripe/recipe-authoring-tools			
silverstripe/recipe-blog				
silverstripe/recipe-collaboration		
silverstripe/recipe-form-building		
silverstripe/recipe-reporting-tools		
silverstripe/recipe-services	
silverstripe/registry		
silverstripe/reports		
silverstripe/restfulserver				
silverstripe/secureassets				
silverstripe/securityreport				
silverstripe/segment-field		
silverstripe/selectupload				
silverstripe/sharedraftcontent				
silverstripe/siteconfig		
silverstripe/sitewidecontent-report		
silverstripe/spamprotection				
silverstripe/spellcheck			
silverstripe/sqlite3				
silverstripe/sspak			
silverstripe/staticpublisher				
silverstripe/staticpublishqueue			
silverstripe/subsites			
silverstripe/tagfield			
silverstripe/taxonomy			
silverstripe/textextraction		
silverstripe/translatable
silverstripe/vendor-plugin			
silverstripe/versioned-admin		
silverstripe/versionfeed	
silverstripe/widgets	
symbiote/silverstripe-advancedworkflow		
symbiote/silverstripe-gridfieldextensions	
symbiote/silverstripe-multivaluefield	
symbiote/silverstripe-queuedjobs
symbiote/silverstripe-versionedfiles		
tijsverkoyen/akismet			
tractorcow/silverstripe-fluent		
undefinedoffset/sortablegridfield

@chillu
Copy link
Member

chillu commented Jun 6, 2018

I've read through https://www.silverstripe.org/software/addons/supported-modules-definition/, and would suggest some changes to that list based on it. In particular, reclassifying some of this as a "supported dependency" with lessened expectations on our maintenance efforts. Maybe that's the case for some of the below already, can't tell from the list :)

  • silverstripe/behat-extension: Should become a "supported dependency". It's one way through which we perform testing, and while it's heavily used in core, it's not had much adoption beyond that. There's a lot of other ways to do this in the wider ecosystem. I don't want this to tie us down if we decide to switch to one of those in core.
  • silverstripe/moduleratings and silverstripe/moduleratings-plugin: Those are means to an end (site summariser), so I'd say they're a "supported dependency".
  • silverstripe/mssql: That shouldn't be on this list, it's not part of any of our QA processes, and we actively steer people away from using it
  • silverstripe/raygun: It's useful to SilverStripe Ltd, but I don't see why it needs to be supported beyond that
  • silverstripe/webpack-config: That's an internal tool to avoid repetition, "supported dependency" at best
  • tractorcow/classproxy and tractorcow/silverstripe-proxy-db: Not sure why those are on the list?
  • silverstripe/graphql-devtool: Make this a "supported dependency"
  • silverstripe/staticpublisher: We aren't really supporting this, and steer people towards the (actually supported) silverstripe/staticpublishqueue. Is it time to stop supporting this officially?

@robbieaverill
Copy link

tractorcow/classproxy and tractorcow/silverstripe-proxy-db: Not sure why those are on the list?

They're dependencies of silverstripe/fulltextsearch, silverstripe/auditor and lekoala/silverstripe-debugbar

@raissanorth raissanorth force-pushed the pulls/update-list-to-include-ss4-and-cwp2.0 branch from 5220f4f to 97b14dd Compare June 11, 2018 01:39
@raissanorth
Copy link
Author

@chillu Thanks for your feedback.

I have changed the behat-extension, moduleratings, moduleratings-plugin, graphql-devtools to supported dependencies.

I have removed mssql, webpack-config, staticpublisher and raygun from the list.

I addedproxy-db as a supported dependency because a number of supported modules depend on it, e.g. auditor and fulltextsearch. classproxy is a dependency for proxy-db . @tractorcow What are your plans for the future of these? Are they gonna go into core?

@raissanorth
Copy link
Author

I published the latest version of the list to https://www.silverstripe.org/software/addons/silverstripe-commercially-supported-module-list/
Could you please sanity check @be2n @brynwhyman, thanks!

@tractorcow
Copy link

I'm hoping that by 5.0 we'll have a DB API that lets us extend the database classes properly without needing a proxy. I'll support the proxy modules until that time.

@be2n
Copy link

be2n commented Jun 11, 2018

Would it make sense to have a timestamp on when the list was last updated?

@chillu
Copy link
Member

chillu commented Jun 11, 2018

Lookin' good! One question: Why is dnadesign/silverstripe-elemental a supported dependency rather than a supported module?

@raissanorth
Copy link
Author

raissanorth commented Jun 11, 2018

Good idea! I added a "timestamp" below the list featured on https://www.silverstripe.org/software/addons/silverstripe-commercially-supported-module-list/.

If there is a better way to do this within the CMS, please let me know.

image

@raissanorth
Copy link
Author

@chillu, nice spotting! I will update dnadesign/silverstripe-elemental to a supported module.

@raissanorth raissanorth force-pushed the pulls/update-list-to-include-ss4-and-cwp2.0 branch from 97b14dd to 01bfc0b Compare June 11, 2018 21:04
…ecipes

Also introduce two new boolean attributes, scrutinizer and addons, to aid in displaying the table of modules. Deleted uncommented code. Link to addons page, rather than GitHub. Update links of repos that moved from GitLab to GitHub. Update references to silverstripe-australia, since renaming to symbiote. Retrieve badges directly from Scrutinizer where possible and display custom shield badge, where not possible.
@raissanorth raissanorth force-pushed the pulls/update-list-to-include-ss4-and-cwp2.0 branch from 01bfc0b to b22175a Compare June 11, 2018 21:07
@robbieaverill robbieaverill merged commit 03460d5 into silverstripe:gh-pages Jun 11, 2018
@robbieaverill robbieaverill deleted the pulls/update-list-to-include-ss4-and-cwp2.0 branch June 11, 2018 22:51
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.

5 participants