starkandwayne/cf-cli-plugin-repo

Name: cf-cli-plugin-repo

Owner: Stark & Wayne

Description: Public repository for community created CF CLI plugins.

Forked from: cloudfoundry/cli-plugin-repo

Created: 2017-09-22 05:12:20.0

Updated: 2017-09-22 05:12:52.0

Pushed: 2017-09-22 06:58:42.0

Homepage: https://plugins.cloudfoundry.org

Size: 13465

Language: Go

GitHub Committers

User	Most Recent Commit	# Commits

Other Committers

User	Email	Most Recent Commit	# Commits

README

Cloud Foundry CLI Plugin Repository (CLIPR)

This is a public repository for community created CF CLI plugins. To submit your plugin approval, please submit a pull request according to the guidelines below.

Submitting Plugins

1. You need to have git installed

2. Clone this repo git clone https://github.com/cloudfoundry-incubator/cli-plugin-repo

3. Include your plugin information in repo-index.yml, here is an example of a new plugin entry

4. authors:

   • contact: contact@sample-author.io homepage: https://github.com/sample-author name: Sample-Author binaries:
   • checksum: 2a087d5cddcfb057fbda91e611c33f46 platform: osx url: https://github.com/sample-author/new_plugin/releases/download/v1.0.0/echo_darwin
   • checksum: b4550d6594a3358563b9dcb81e40fd66 platform: win64 url: https://github.com/sample-author/new_plugin/releases/download/v1.0.0/echo_win64.exe
   • checksum: f6540d6594a9684563b9lfa81e23id93 platform: linux32 url: https://github.com/sample-author/new_plugin/releases/download/v1.0.0/echo_linux32 company: created: 2015-01-31T00:00:00Z description: new_plugin to be made available for the CF community homepage: https://github.com/sample-author/new_plugin name: new_plugin updated: 2015-01-31T00:00:00Z version: 1.0.0

     se make sure the spacing and colons are correct and that the fields are alphabetized in the entry. The following describes each field's usage.
     

   Field | Description —— | ——— authors | Fields to detail the authors of the plugin
   name: name of author
   homepage: Optional link to the homepage of the author
   contact: Optional ways to contact author, email, twitter, phone etc … binaries | This section has fields detailing the various binary versions of your plugin. To reach as large an audience as possible, we encourage contributors to cross-compile their plugins on as many platforms as possible. Go provides everything you need to cross-compile for different platforms
   platform: The os for this binary. Supports osx, linux32, linux64, win32, win64
url: HTTPS link to the binary file itself
   checksum: SHA-1 of the binary file for verification
   Please use a unique URL for each updated release version of your plugin, as each binary will have a unique checksum. company | Optional field detailing company or organization that created the plugin created | date of first submission of the plugin, in iso 8601 combined date and time with timezone format description | describe your plugin in a line or two. this description will show up when your plugin is listed on the command line homepage | Link to the homepage where the source code is hosted. Currently we only support open source plugins name | name of your plugin, must not conflict with other existing plugins in the repo. updated | Date of last update of the plugin, in ISO 8601 Combined Date and Time with Timezone Format version | version number of your plugin, in [major].[minor].[build] form

5. run go run sort/main.go repo-index.yml. This will sort your additions to the file.

6. After making the changes, fork the repository

7. Add your fork as a remote

   GOPATH/src/github.com/cloudfoundry-incubator/cli-plugin-repo
   remote add your_name https://github.com/your_name/cli-plugin-repo
   

8. Push the changes to your fork and submit a Pull Request

Releasing Plugins

Cross-compile to the 3 different operating systems

Golang supports cross compilation to several systems and architectures. Theres an in-depth article by Dave Cheney here explaining how to do it and how it works. You can also find a list of supported systems and architectures here under the $GOOS and $GOARCH section.

The CF cli supports 5 combinations:

• linux/386 (known as linux32)
• linux/amd64 (known as linux64)
• windows/386 (known as win32)
• windows/amd64 (known as win64)
• darwin/amd64 (known as osx)

And at a minimum we want plugins to support linux64, win64 and osx.

So, with all that, you can generate those binaries for your plugin with the following snippet:

IN_PATH=$GOPATH/src/my-plugin
IN_NAME=$(basename $PLUGIN_PATH)

PLUGIN_PATH
=linux GOARCH=amd64 go build -o ${PLUGIN_NAME}.linux64
=linux GOARCH=386 go build -o ${PLUGIN_NAME}.linux32
=windows GOARCH=amd64 go build -o ${PLUGIN_NAME}.win64
=windows GOARCH=386 go build -o ${PLUGIN_NAME}.win32
=darwin GOARCH=amd64 go build -o ${PLUGIN_NAME}.osx

Sign Windows binaries

_LOCATION=my-cert-location
_PASSWORD=my-cert-password
IN_BINARY_NAME=my-plugin.win32

r signed-binaries
signcode sign \
kcs12 $CERT_LOCATION \
ass $CERT_PASSWORD \
 http://timestamp.comodoca.com/authenticode \
 sha256 \
n ${PLUGIN_BINARY_NAME} \
ut signed-binaries/${PLUGIN_BINARY_NAME}
f ${PLUGIN_BINARY_NAME}

Checksums

Checksums in the repo-index.yml file are used to verify the integrity of the binaries, to prevent corrupted downloads from being installed. We use the sha-1 checksum algorithm, you can compute it with: shasum -a 1 <myfile>

So continuing the above snipped you'd do:

um -a 1 ${PLUGIN_NAME}.linux64
um -a 1 ${PLUGIN_NAME}.linux32
um -a 1 ${PLUGIN_NAME}.win64
um -a 1 ${PLUGIN_NAME}.win32
um -a 1 ${PLUGIN_NAME}.osx

Take note of those so that you can put them on repo-index.yml later when you have uploaded the binaries.

Release the binary publicly

You could use whatever file hosting you like here, the easiest and recommended one is GitHub releases, given that your plugin's code is already hosted on GitHub it might be the easiest solution too.

You can read more about GitHub Releases here but for the purposes of releasing your plugin you should upload those five binaries generated above on the same release.

You should then copy the resulting links for the uploaded binaries from the release page and put them on the repo-index.yml file.

This process can get a little tedious if you do it manually every time, that's why some plugin developers have automated it. You can probably put together scripts based on the snippets above to automate compiling, generating checksums and uploading the release to GitHub. There are tools available to manage GitHub releases such as this one.

Running your own Plugin Repo Server

Included as part of this repository is the CLI Plugin Repo (CLIPR), a reference implementation of a repo server. For information on how to run CLIPR or how to write your own, please see the CLIPR documentation here.