Skip to content

Document Plugin Best Practices #14129

@jdaugherty

Description

@jdaugherty

Issue description

Throughout the upgrade of Grails 7, we have discovered several best practices for plugins. The purpose of this ticket is to document those practices and add a section to the Grails Guide for guidance. The intent is to limit the need to update these plugins in the future via this guidance.

Some of these practices include:

  • using provided scopes such as 'compileOnly' to not tie to a specific coordinate name
  • splitting the plugin logic from it's examples. i.e. the plugin gradle project should only include plugin code
  • ensuring github actions are setup to build your plugin
  • using grailsPublish to ensure your sources, javadoc, groovydoc, etc are published correctly

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    Status

    No status

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions