https://github.com/grails/grails-plugins-metadata

https://github.com/grails/grails-plugins-metadata

Last synced: over 1 year ago
JSON representation

• Host: GitHub
• URL: https://github.com/grails/grails-plugins-metadata
• Owner: grails
• Created: 2021-03-18T10:51:08.000Z (about 5 years ago)
• Default Branch: main
• Last Pushed: 2025-02-18T16:04:12.000Z (over 1 year ago)
• Last Synced: 2025-02-18T17:22:31.760Z (over 1 year ago)
• Size: 7.6 MB
• Stars: 2
• Watchers: 10
• Forks: 9
• Open Issues: 4
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# Grails Plugin Page Data Source

This repository hosts the data used by the [Grails Plugin Page](https://www.grails.org/plugins.html) to list and display plugin information.

## Adding Your Plugin to the Grails Plugin Page

To have your plugin listed on the Grails Plugin Page, follow these steps:

 

1. Open the [grails-plugins.json](grails-plugins.json) file in this repository.

2. Add a new entry with the following structure to the **end of the JSON list**:

```json

{

    "bintrayPackage": {

        "name": "Your Plugin Name",

        "repo": "your-plugin-repo-name",

        "owner": "your-github-username",

        "desc": "A concise description of your plugin",

        "labels": [

            "relevant-label",

            "check-existing-labels"

        ],

        "licenses": [

            "Apache-2.0"

        ],

        "issueTrackerUrl": "https://github.com/your-github-username/your-plugin-repo/issues",

        "latestVersion": "1.0",

        "updated": "2024-12-25T04:00:40.855Z",

        "systemIds": [

            "your.plugin.maven:coords"

        ],

        "vcsUrl": "https://github.com/your-github-username/your-plugin-repo-name"

    },

    "documentationUrl": "https://github.com/your-github-username/your-plugin-repo-name#readme",

    "mavenMetadataUrl": "https://repo1.maven.org/maven2/your/plugin/maven/coords/maven-metadata.xml"

}

```

3. Create a **Pull Request** with your changes.

4. Wait for approval. Once merged, your plugin will appear on the Grails Plugin Page.

## Updating Your Plugin

When you release a new version of your plugin, the system will automatically generate a Pull Request to update your plugin's entry in this repository. A member of the Grails team will review and merge the update.