piperika

README

About this plugin

This is a JFrog Pipelines CLI utility with an emphasis on the consumer experience.
As a consumer of CI/CD system, you don't always want to understand the complexity but just "use" it.

Piperika provides a single command that does all the complex work for you.
All you need to do is to commit and push your code, and launch Piperika. It will start the CI on your branch, follow the build process and show you all the relevant data including your progress.

What will Piperika do?

• Validate that your local commit is on the remote git server (so the CI server could reach it)
• Sync Pipelines with your branch and latest commit SHA (if needed).
• Check if there is a CI pipe that is already running with your commit, if not, it will trigger it.
• Follow up your CI run, providing the current state and progress, information about your run steps (in progress, succeed and failed steps), and displays information about tests failure.

Installation with JFrog CLI

Installing the latest version:

$ jf plugin install piperika

Installing a specific version:

$ jf plugin install piperika@version

Uninstalling a plugin

$ jf plugin uninstall piperika

Building from source

To build the Piperika binary

$ make build

To build the Piperika binary for multiple operating systems and architectures (Mac, Linux and Windows)

$ make build-multi-os

To install the plugin to the JFrog CLI

$ make install

Usage

Configuration

JFrog Pipelines only accepts Access Tokens for authentication and authorization.

1. Create an identity token or admin token via Artifactory UI.
   
2. Create a new JFrog CLI profile, and when asked, insert the Access Token you generated in the first step.
   

Commands

jf piperika run (or just jf piperika r)

It will:

1. Validate that your git branch is ready to run.
2. Trigger a run if needed.
3. Attach to the Pipelines run and show you the progress.
   
   

Output example for a successful Pipelines run:

Output example for a Pipelines run that had a unit test failure:

Release Notes

The release notes are available here.

Owners

Hanoch Giner
Itai Raz
Omer Karjevsky