pinpoint

README

This repo contains the pinpoint utility

Overview

The Pinpoint utility tool

Installation

OSX with Homebrew

To install the latest release using Brew, run the following in your shell:

brew install pinpt/tap/pinpoint

Unix or OSX without Homebrew

To install the latest release, run the following in your shell:

bash -c "$(curl -sSL https://raw.githubusercontent.com/pinpt/pinpoint/master/install.sh)"

Usage

This tool supports various different reporting options.

Build

To report build status, you will invoke the tool twice: first to indicate the start of a build and second to indicate the completion of the build.

To start the build:

pinpoint build start

To finish the build:

pinpoint build finish

By default, if no arguments are provided, reasonable defaults will attempt to be set. However, there are a number of ways to configure the build based on the stage.

Start Configuration

• repo: the name of the repo such as foo/bar
• sha: the commit sha for the build
• dir: the directory where the source code for the build exists, defaults to current working directory
• automated: true (default) if the build is automated, false if manual
• env: the environment which is one of: production, development, beta, staging, test, other. defaults to production

Finish Configuration

• repo: the name of the repo such as foo/bar
• sha: the commit sha for the build
• dir: the directory where the source code for the build exists, defaults to current working directory
• url: the optional build url if the build system has a status page for the build
• status: the status which is one of: pass, fail, cancel. defaults to pass
• apikey: the apikey to transmit the information to the Pinpoint Cloud
• dry-run: if true, print the JSON data to be sent to the Pinpoint Cloud and exit

To use a configuration from the command-line, pass it in as an option such as:

pinpoint build finish --dry-run --status fail

Example CircleCI Configuration

The following is an example configuration for CircleCI:

	- run: bash -c "$(curl -sSL https://raw.githubusercontent.com/pinpt/pinpoint/master/install.sh)"
	- run: echo 'export PATH=$HOME/.pinpoint:$PATH' >> $BASH_ENV
	- run: pinpoint build start

Then somewhere after your build add:

	- run: pinpoint build finish

You should generally set the value PP_APIKEY to your API Key or you can pass it in using --apikey.

Deploy

TODO

License

All of this code is Copyright © 2019 by Pinpoint Software, Inc. and licensed under the Apache Public License, version 2.