From 8ea5cfa2aaf644251dee88257ca3b41006de2dde Mon Sep 17 00:00:00 2001 From: Michael Hobbs Date: Tue, 25 Aug 2015 16:45:04 -0700 Subject: [PATCH] document 'public' functions convention --- docs/development/plugin-creation.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/development/plugin-creation.md b/docs/development/plugin-creation.md index 78f3e0f9e..90a7a338c 100644 --- a/docs/development/plugin-creation.md +++ b/docs/development/plugin-creation.md @@ -80,4 +80,5 @@ A few notes: dokku config:set --no-restart APP KEY1=VALUE1 [KEY2=VALUE2 ...] dokku config:unset --no-restart APP KEY1 [KEY2 ...] ``` +- From time to time you may want to allow other plugins access to (some of) your plugin's functionality. You can expose this by including a `functions` file in your plugin for others to source. Consider all functions in that file to be publicly accessible by other plugins. Any functions not wished to be made "public" should reside within your pluginhook or commands files. - As of 0.4.0, we allow image tagging and deployment of said tagged images. Therefore, hard-coding of `$IMAGE` as `dokku/$APP` is no longer sufficient. Instead, for non `pre/post-build-*` plugins, use `get_running_image_tag()` & `get_app_image_name()` as sourced from common/functions. See [pluginhooks](http://progrium.viewdocs.io/dokku/development/pluginhooks) doc for examples.