cirocket

README

cirocket

Rocket powered task runner to assist delivering developer and ci build missions.

• Installation
• Features
• Basic usage
• Contributing

Status

This project is at alpha MVP stage. It may be subject to change or redesign, but the hope is not to break any existing scripts using the tool.

Documentation is limited. Current sources include this README, cli help (cirocket --help) and the sample config file generated by running cirocket init mission Further documentation is planned.

If you find and problem or want to contribute please see the contribution section below.

Installation

The application can be installed via:

• Pre-build release binaries
• Homebrew
• As a docker image
• Using the Go tool chain
• From source by cloning this repository

Homebrew

brew install nehemming/tap/cirocket

Go tool chain

go install github.com/nehemming/cirocket@latest

From source code

git clone https://github.com/nehemming/cirocket.git
cd cirocket
go install

Features

cirocket is a task runner that is designed to support developers' local and ci build processes in a platform agnostic way.

It provides two modes of operation:

1. Launching local task scripts, known as missions.
2. Assembling and running shared project blueprint scripts and using a runbook to tailor its steps and parameters.

Launching missions

Launch scripts are typically used to run local build/test/venerability scripts or to prepare a project for pushing to a public repo. In a ci environment cirocket can help sequence the build steps, report code coverage, Fossa checks etc.

Examples used by the authors can be found at cirocket-config.

The launch command features:

• Simple Yaml based configuration splitting missions into stages and tasks.
• Supports go template expansion of properties
• Executes task applications with io redirection to logs, variable or just plain console output
• Configuration support include scripts located either on a local filesystem or pulled from a url web resource.
• Supports both environment variables and parameters that can load values inline, from file or be pulled from the web.
• Stages can be run in the order defined in the file or a sequence can be specified to run specific stages only.
• Restricting of tasks to only run on certain platforms. I.e. if you run from Linux, ypou may want to execute a shell script but on windows use a power shell one instead.

Launch features are delivered through two commands.

Command	Description
cirocket init mission	Creates a starting mission script that is ready for you to edit. The default script created is called .cirocket.yml and is placed in the current working directory. It will NOT overwrite an existing script. The arg --mission [path] allows an alterative local file to be specified.
cirocket launch	Runs the mission script, either identified by --mission [path] or the default .cirocket.yml.

Assembling blueprints

Blueprints are essentially template cirocket scripts that c an be run to carry out common project or development tasks. The example script contained in this project creates a new hello world project and builds it.

Blueprints are intended to replace a reliance of shell history or adhoc shell./ batch scripts to accomplish common tasks.

Blueprint features:

• Simple Yaml based configuration.
• Supports all the features of the launch command.
• Blueprints can be local or stored on the web (including github.com repositories).
• Tailored execution using a Yaml runbook scripts

Launch features are delivered through two commands.

Command	Description
cirocket init runbook [blueprint]	Finds the blue print and creates a new Yaml runbook file ready for local editing.
cirocket assemble [blueprint]	Locates and runs the blueprint. If --runbook [runbook_path] is specified the selected runbook will be used to control the blueprint build.

Basic usage

cirocket is a simple task runner application that uses a configuration file to specify the tasks.

Command line help is available with cirocket --help

To create a sample config file, along with some basic documentation run:

cirocket init mission

This will create a .cirocket.yml file in the current working directory.

Here is example sample

Once edited the file can be run using

cirocket launch

Different mission files can be specified by adding to either command the --mission <filename> flag.

Docker

CI Rocket a basic docker image available in packages.

To use the image, either pull it or include it in Dockerfile FROM statement.

docker pull ghcr.io/nehemming/cirocket:latest

The tool is best used with a mounted volume pointing at your project.

docker run --rm -ti -v /host/project:/project cirocket --dir /project init

TIP: The --dir flag switches to the supplied directory before running the tool.

Contributing

We would welcome contributions to this project. Please read our CONTRIBUTION file for further details on how you can participate or report any issues.

License

This software is licensed under the Apache License.

Documentation

Overview

Application cirocket is a command line task runner tool aimed at support automated development activities.