commit	90bc86ab37310ff70620617bcded36d84abd1fbe	[log] [tgz]
author	Puneet Behl <behlp@unityfoundation.io>	Tue Feb 27 00:04:33 2024 +0530
committer	GitHub <noreply@github.com>	Tue Feb 27 00:04:33 2024 +0530
tree	5edf54a9cd45f4c638dc1d31a4388be4aa47ef30
parent	5d23c0dda91c7a0007003b4cc639efdf3d1116ba [diff]

tree: 5edf54a9cd45f4c638dc1d31a4388be4aa47ef30

README.md

Grails Plugin Portal - Metadata

This repository hosts the metadata used by Grails Plugin Portal to list/show plugins information.

Update Information on the Grails Plugin Portal

The Grails Plugin Portal uses the grails-plugins.json metadata file to display plugin information.

When you publish a new plugin or release an existing plugin, you must send a pull request to this file to update the information on the portal.

When you release a new plugin, add the following information at the end of the JSON file:

{
    "bintrayPackage": {
        "name": "My Plugin",
        "repo": "plugins",
        "owner": "puneetbehl",
        "desc": "A concise description",
        "labels": [
                "grails3",
                "spring-boot",
                "test-label"
        ],
        "licenses": [
                "Apache-2.0"
        ],
        "issueTrackerUrl": "https://github.com/puneetbehl/myplugin/issues",
        "latestVersion": "1.1",
        "updated": "2021-03-25T04:00:40.855Z",
        "systemIds": [
                "io.github.puneetbehl:myplugin"
        ],
        "vcsUrl": "https://github.com/puneetbehl/myplugin"
    },
    "documentationUrl": "https://puneetbehl.github.io/myplugin/",
    "mavenMetadataUrl": "https://repo1.maven.org/maven2/com/github/puneetbehl/myplugin/maven-metadata.xml"
}

If you publish a new version to Maven Central, locate the entry in the JSON file and updatelatestVersion and mavenMetadataUrl. This will reflect the latest version in the plugin portal. In the future, we will use the mavenMetadataUrl field to automatically update the latest version.