github.com/cloudfoundry/cli@v7.1.0+incompatible/plugin/plugin_examples/CHANGELOG.md (about)

     1  [Go here for documentation of the plugin API](https://github.com/cloudfoundry/cli/blob/master/plugin/plugin_examples/DOC.md)
     2  
     3  # Changes in v6.25.0
     4  - `GetApp` now returns `Path` and `Port` information.
     5  
     6  # Changes in v6.24.0
     7  - API `LoggregatorEndpoint()` is deprecated and now always returns the empty string. Use `DopplerEndpoint()` instead to obtain logs.
     8  
     9  # Changes in v6.17.0
    10  - `-v` is now a global flag to enable verbose logging of API calls, equivalent to `CF_TRACE=true`. This means that the `-v` flag will no longer be passed to plugins.
    11  
    12  # Changes in v6.14.0
    13  - API `AccessToken()` now provides a refreshed o-auth token.
    14  - [Examples](https://github.com/cloudfoundry/cli/tree/master/plugin/plugin_examples#test-driven-development-tdd) on how to use fake `CliConnection` and test RPC server for TDD development.
    15  - Fix Plugin API file descriptors leakage.
    16  - Fix bug where some CLI versions does not respect `PluginMetadata.MinCliVersion`.
    17  - The field `PackageUpdatedAt` returned by `GetApp()` API is now populated.
    18  
    19  # Changes in v6.12.0
    20  - New API:
    21  ```go
    22  GetApp(string) (plugin_models.GetAppModel, error)
    23  GetApps() ([]plugin_models.GetAppsModel, error)
    24  GetOrgs() ([]plugin_models.GetOrgs_Model, error)
    25  GetSpaces() ([]plugin_models.GetSpaces_Model, error)
    26  GetOrgUsers(string, ...string) ([]plugin_models.GetOrgUsers_Model, error)
    27  GetSpaceUsers(string, string) ([]plugin_models.GetSpaceUsers_Model, error)
    28  GetServices() ([]plugin_models.GetServices_Model, error)
    29  GetService(string) (plugin_models.GetService_Model, error)
    30  GetOrg(string) (plugin_models.GetOrg_Model, error)
    31  GetSpace(string) (plugin_models.GetSpace_Model, error)
    32  ```
    33  - Allow minimum CLI version required to be specified in plugin. Example:
    34  ```go
    35  func (c *cmd) GetMetadata() plugin.PluginMetadata {
    36  	return plugin.PluginMetadata{
    37  		Name: "Test1",
    38  		MinCliVersion: plugin.VersionType{
    39  			Major: 6,
    40  			Minor: 12,
    41  			Build: 0,
    42  		},
    43  	}
    44  }
    45  ```
    46  
    47  # Changes in v6.11.2
    48  Added the following commands to cli_connection.go:
    49  ```go
    50    - GetCurrentOrg()  
    51    - GetCurrentSpace()  
    52    - Username()  
    53    - UserEmail()  
    54    - UserGuid()  
    55    - HasOrganization()  
    56    - HasSpace()  
    57    - IsLoggedIn()  
    58    - IsSSLDisabled()  
    59    - ApiEndpoint()  
    60    - HasAPIEndpoint()  
    61    - ApiVersion()  
    62    - LoggregatorEndpoint()  
    63    - DopplerEndpoint()  
    64    - AccessToken()  
    65  ```
    66  
    67  # Changes in v6.11.0
    68  - Plugins now have a hook-in that is called when the plugin is uninstalled, allowing cleanup of files.
    69  
    70  # Changes in v6.10.0
    71  [CF-Community Plugin Repository](https://github.com/cloudfoundry/cli-plugin-repo) introduced.
    72  - Plugin developers can submit any open-source plugins
    73  - Plugins in the community repo can be browsed and installed from the CLI
    74  
    75  # Changes in v6.9.0
    76  - Plugins can now have versions, i.e. 1.2.3, [code example](https://github.com/cloudfoundry/cli/blob/master/plugin/plugin_examples/basic_plugin.go)
    77  - `cf plugins` now displays plugin versions
    78  - `-h` and `--help` flags work with plugin commands. e.g. `cf <plugin-command> -h`. [code example](https://github.com/cloudfoundry/cli/blob/master/plugin/plugin_examples/echo.go)
    79  - Allow `cf help <plugin-command>`
    80  
    81  # Changes in v6.8.0
    82  - Plugin commands can now have aliases
    83  - Help text for plugins now listed in 'cf plugins'
    84  
    85  # Changes in v6.7.0
    86  - Plugins introduced