How to make my ss4 module display on the ss addon list?

AlexStack · 3 July 2019 10:34

Hi,

I’ve created an ss4 module: alexstack/silverstripe-custom-page-with-contact-us-form - Packagist

The composer.json code is:

AlexStack/SilverStripe-Custom-Layout-Page-with-Contact-Us-Form/blob/master/composer.json

{
    "name": "alexstack/silverstripe-custom-page-with-contact-us-form",
    "description": "SilverStripe Custom Layout Page with Contact Us Form & flexible frontend with Google Recaptcha.",
    "type": "silverstripe-vendormodule",
    "homepage": "https://github.com/AlexStack/SilverStripe-Custom-Layout-Page-with-Contact-Us-Form/",
    "keywords": ["silverstripe", "custom-layout","contact-form", "contact-us", "contact-us-form", "form", "contact", "module", "contact us", "contact form", "contact us form", "custom form"],
    "license": "BSD-3-Clause",
    "support": {
        "issues": "https://github.com/AlexStack/SilverStripe-Custom-Layout-Page-with-Contact-Us-Form/issues"
    },
    "authors": [{
        "name": "Alex",
        "homepage": "https://github.com/AlexStack/"
    }],
    "require": {
        "silverstripe/cms": "~4.0",
        "silverstripe/framework": "~4.0",
        "silverstripe/vendor-plugin": "^1.0",
        "alexstack/google-recaptcha-to-any-form": "^1.0"
    },

This file has been truncated. show original

My question is How to make my ss4 module display on the ss addon list?
https://addons.silverstripe.org/add-ons

Many thanks
Alex

Tim · 3 July 2019 10:41

Once you submit to packagist, the add-ons directory should update automatically. It usually takes a few hours to happen though.

Looks like your module is in there now: Add-ons · SilverStripe Add-ons

AlexStack · 3 July 2019 21:21

@Tim Thank you for your quick reply. Yes, the addon shows up now but the weired thing is no readme.

I’ve got the readme.md in Github, Do you have any idea why it does not show up here: https://addons.silverstripe.org/add-ons/alexstack/silverstripe-custom-page-with-contact-us-form

Thanks

Tim · 4 July 2019 07:17

The only thing I can see which might be a possibility is that your readme file has a lower-case filename. I’m wondering if the add-ons directory expects to find README.md instead. (The modules where it shows up seem to use this format).

May be worth changing the filename and doing a release to test. (It’ll likely take an overnight refresh before it shows up still)