cirocket

cirocket

Rocket powered task runner to assist delivering ci build missions

Status

This project is in its early 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 and the sample config file generated by cirocket init

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 golang 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

Basic usage

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

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

cirocket init

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 --config <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.