pivotal-cf/spring-cloud-dataflow-for-pcf-cli-plugin

Name: spring-cloud-dataflow-for-pcf-cli-plugin

Owner: Pivotal Cloud Foundry

Description: A Cloud Foundry CLI plugin for Spring Cloud Dataflow for PCF

Created: 2017-11-01 15:16:02.0

Updated: 2017-11-01 16:05:33.0

Pushed: 2018-02-02 17:08:07.0

Homepage:

Size: 1896

Language: Go

GitHub Committers

User	Most Recent Commit	# Commits

Other Committers

User	Email	Most Recent Commit	# Commits

README

Spring Cloud Dataflow for PCF CLI Plugin

This repository provides a Cloud Foundry CLI plugin for Spring Cloud Dataflow for PCF.

For information on plugin development, see Developing a plugin.

Building

To build the plugin, install go and govendor (see the Go Development guide for instructions) and issue:

 $GOPATH/bin/spring-cloud-dataflow-for-pcf-cli-plugin
 $GOPATH/src/github.com/pivotal-cf/spring-cloud-dataflow-for-pcf-cli-plugin
vendor install -ldflags="-X main.pluginVersion=$(cat version)" +local

This builds the plugin with the current version number in the version file.

Note: if an invalid version number is provided, the build will succeed, but the plugin will fail to install (with exit status code 64).

To print the version number of the built plugin, run it as a stand-alone executable, for example:

OPATH/bin/spring-cloud-dataflow-for-pcf-cli-plugin
 program is a plugin which expects to be installed into the cf CLI. It is not intended to be run stand-alone.
in version: 0.0.8

Installing

To install the plugin in the cf CLI, first build it and then issue:

 install-plugin -f $GOPATH/bin/spring-cloud-dataflow-for-pcf-cli-plugin

The plugin's commands may then be listed by issuing cf help.

To update the plugin, uninstall it as follows and then re-install the plugin as above:

 uninstall-plugin spring-cloud-dataflow-for-pcf-cli-plugin

Command docs

The Spring Cloud Dataflow for PCF CLI plugin command docs can be generated by running the following commands:

 docs
generate-cli-docs-from-help.bash

This needs to be done whenever commands are added, modified, or deleted. Note that the script contains a list of commands which needs to be kept in step with the available commands.

The generated docs may be viewed here.

Go Development

See the Go Development guide. (If you just want to build and install the plugin, simply install go and govendor.)

Testing

Run the tests as follows:

 $GOPATH/src/github.com/pivotal-cf/spring-cloud-dataflow-for-cli-plugin
vendor test +local

License

The Spring Cloud Dataflow for PCF CLI plugin is Open Source software released under the Apache 2.0 license.

Contributing

Contributions are welcomed. Please refer to the Contributor's Guide.